README Documentation Guide

Proposed format

• Project name: Your project’s name is the first thing people will see upon scrolling down to your README, and is included upon creation of your README file.
• Description: A description of your project follows. A good description is clear, short, and to the point. Describe the importance of your project, and what it does.
• Table of Contents: Optionally, include a table of contents in order to allow other people to quickly navigate especially long or detailed READMEs.
• Installation: Installation is the next section in an effective README. Tell other users how to install your project locally. Optionally, include a gif to make the process even more clear for other people.
• Usage: The next section is usage, in which you instruct other people on how to use your project after they’ve installed it. This would also be a good place to include screenshots of your project in action.
• Credits: Include a section for credits in order to highlight and link to the authors of your project.
• License: Finally, include a section for the license of your project. For more information on choosing a license, check out GitHub’s licensing guide!

README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis, outlined below.