A good description is clear, short, and to the point. Describe the purpose of the project and what it does. Your README should contain only the necessary information for developers to get started contributing to your project.
Describe how to install the project locally then DELETE THIS LINE. For example:
git clone [email protected]:qctrl/[REPOSITORY].git cd [REPOSITORY] install...
Describe how to use the project after installation then DELETE THIS LINE. For example:
run...
See Contributing.
Replace [REPOSITORY] in the URL below with the name of the repository then DELETE THIS LINE.
See Contributors.
- If Unlicensed:
- Delete this entire License section.
- DELETE THIS LIST.
See LICENSE.