README Guidelines

Why use a README?

A project's README maybe the only file a potential user may ever read. Therefore, the layout and information contained in the README is very important.

Minimum README

A README should at least provide:

• What is the project
• Why use the project
• Getting started
• Features
• Configuration
• How to build
• Contributing

Useful Links

• https://thejunkland.com/blog/how-to-write-good-readme.html
• https://bulldogjob.com/news/449-how-to-write-a-good-readme-for-your-github-project
• https://thoughtbot.com/blog/how-to-write-a-great-readme
• https://changelog.com/posts/top-ten-reasons-why-i-wont-use-your-open-source-project