Badges
tests, DOI, compliance with community standards
Description
one short paragraph about your project’s goal and context
Installation
step-by-step guide, e.g. download and install the package include details on where to enter the commands - users may not know that a command needs to be entered in the shell / command-line or how to open the shell / command-line
# code to perform the step
optional check of version or correct installation
# code to perform the check
Prerequisites (if needed)
(if requiring additional libraries, provide instruction or links to How-To guides)
Example Task (rename as needed)
description of the basic task to be demonstrated include instructions to download example data or use example data with the software
# code chunks (as many as needed)
links to tutorial, readings, other resources, etc.
Contributing (if needed)
link to CONTRIBUTING.md and/or CODE_OF_CONDUCT.md for instructions on contributing / submitting pull requests
Acknowledgements
funding sources / acknowledgements for this project
How to Cite
example citation