If you use or are inspired by code in this repository please cite the following work or contact me about how to cite. Please also see license information.
Example et al. (Year) Title. Journal vol:pp-pp. doi_link
Brief blurb about the motivation and structure of this repository, including outcomes (if applicable).
Either a description of the environment used to run code in this repository, or information on how visitors can access that information on a per-file or per-folder basis. This could be as simple as pointing to a conda environment yaml.
conda env create -f conda_environment.yml
If applicable, eg for repositories with pipelines, give usage example. GIFs of terminal are sometimes nice.
but code block-like style works too
This will hold information with brief descriptions of folders or files in this repo. Note that folders can have their own README. It's also useful to provide hyperlinks directly to the file so readers can click and go right to it.
LICENSE - our license information
Each of these examples could be their own section, information within a final header, or within a section above.
- see also (useful links/papers/repos/context etc) ...
- inspired by ...
- vignettes or snippets
- release history
- acknowledgements
- logos
- screenshots
- videos / GIFs
- instructions on how to contribute (feature additions, issues, etc)
- link to documentation (eg readthedocs)