- Describe very briefly but clearly what the project does.
- State if it is out-of-the-box user-friendly, so it’s clear to the user.
- List its most useful/innovative/noteworthy features.
- State its goals/what problem(s) it solves.
- Note and briefly describe any key concepts (technical, philosophical, or both) important to the user’s understanding.
- Link to any supplementary blog posts or project main pages.
- Note its development status.
- Include badges.
- If possible, include screenshots and demo videos.
- Indicate the technological nature of the software, including primary programming language(s) and whether the software is intended as standalone or as a module in a framework or other ecosystem.
- Alpha, Beta, 1.1, etc. It's OK to write a sentence, too. The goal is to let interested people know where this project is at. This is also a good place to link to the CHANGELOG.
Include any essential instructions for:
- Getting it
- Installing It
- Configuring It
- Running it
- Contributor Guidelines
- Code Style/Requirements
- Format for commit messages
- Thank you (name contributors)
- Document any known significant shortcomings with the software.
- Known bugs (shortlist)
- Next steps
- Features planned
- Known bugs (shortlist)
- Projects that inspired me
- Related projects
- Books, papers, talks, or other sources that have meaningful impact or influence on this project