How to Write a README
Different people have different views about what constitutes a good README document for a software project. I think it should be vehicle for delivery of the bare minimum knowledge necessary to convey why someone might want to use it and how.
Imagine you're a trainee who was given a URL to the GitHub page on your first day. You have only the bare resources needed to run the program, but none of the knowledge about it.
What information would you need? Make certain to add that information:
- Brief description of project aimed at somebody who might need it, but hasn't necessarily ever heard of it.
- Link to the projects's home. This might be a github.io site, a Confluence page or a wiki.