PACKAGENAME¶
Replace occurances of “PACKAGENAME” throughout the template with the name of your software package
Where to Find PACKAGENAME¶
Give some basic information about where to find the software
Installation¶
Explain how to install your software, some topics might be:
- requirements
- how to install
- basic usage
- common problems
User Documentation¶
Explain how to use your software
Reporting Issues¶
How and where should users report problems
Contributing¶
Discuss how or if your software accepts contributions. This package template has a default CONTRIBUTING.md file that can be referenced here. It may include sections such as:
- How to make a code contribution
- Coding Guidelines
Reference API¶
Package documentation usually pulled from docstrings inside the code