(Replace this with the name of your software project)¶
(Replace this line with a SHORT description of what your software/project does)
Table of Contents¶
- Introduction
- Quick start
- Documentation
- Support & Roadmap
- License
- Changelog
- Contributing
- Frequently Asked Questions
- References
- Acknowledgements
Introduction¶
(Replace this with a longer description of your software, its features, technical architecture, intended audience, use subsections. Add subsections as desired. Read more here)
Quick start¶
Installation¶
(How to obtain, build & install the application? Remove this line. Add subsections as desired. Read more here)
Usage¶
(How to use the software after installation? Remove this line. Add subsections as desired. Read more here)
Documentation¶
(Replace this with links to more elaborate documentation. Read more here )
Support & Roadmap¶
(Link to support channels, (e.g. an issue tracker), and a roadmap. Remove this line. Read more here )
Licence¶
(Replace this with licensing information, link to a LICENSE.md in the same repository with the full license text. Read more here )
Changelog¶
(Mention important changes between releases. Replace this line. Ideally link to a changelog file or releases page. Read more here )
Contributing¶
(Add notes on how people can contribute, ideally link to a separate CONTRIBUTE.md file. Remove this line. Read more here)
Frequently Asked Questions¶
(Mention frequently asked questions. Troubleshooting information. Remove this line. Read more here )
How to cite this software?¶
(Replace this with an example of how you want the software to be cited from academic publications)
References¶
(Replace this with a bibliography. Read more here )
Acknowledgements¶
(Replace as desired with acknowledgements, make sure to explicitly mention at least the funder. Read more here )