An example README. This Readme is fully standard-readme compliant, and there are more examples in the example-readmes folder. A linter that can be used to look at errors in a given Readme. Please ...

The README file (often README.md or README.rst) is usually the first thing users/collaborators see when visiting your GitHub repository. Use it to communicate important information about your project!