The first thing users and other developers look at when first making contact with a repository is the
README.md in the repository’s root
directory. Its purpose is to give a concise but comprehensive introduction to the project. It should provide links to further (more
detailed) documentation, websites or other background information. Depending on the relevant ecosystem, specific guides or templates for
The following basic information must be provided:
- The project name
- A short but meaningful descriptive summary of the repository
- The maintenance status
The following questions must be answered:
- What does the software do?
- Who will use the software?
- What are alternatives to the software, and how do they differ?
- How can someone get started?
- Binary download location
- Build instructions with dependencies
- Installation instructions
- Quick start examples
- Link to full user documentation
- How can others join the development?
- Coding styles used
- API design
- Toolchain and frameworks used
- Community communication platforms
- Link to developer documentation
- Test suite details
- Contribution guides
- Release details and versioning
- Who has contributed to the software?
- Which license is used? In most cases a link to the LICENSE.txt is sufficient.
- Who has to be acknowledged? I.e. who has played a significant role for the creating of the software? This can e.g. include funding, research communities, or co-workers that are not part of the project but have given advice and/or input to the development process.