forked from ITC-CRIB/meta-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.md.jinja
33 lines (20 loc) · 1.16 KB
/
README.md.jinja
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# {{software_name}}
{{software_purpose}}
## Installation
[Describe the steps that users (not developers) should follow to install the code in each of the intended platforms (e.g. Window 10, MacOS, etc.).]
**Requirements**
- [List the software, OS, and/or technologies on which the code depends, and add hyperlinks to the sources whenever possible.]
- [State any relevant hardware requirements.]
{% if community %}
### Community
If you want to contribute with the development of {{ software_name}}, read our [contriguting guidelines](CONTRIBUTING.md).
{% endif %}
## License
This software is distributed under a [{{ software_license }}](LICENSE).
## Copyright
© {{ copyright_holder }}, The Netherlands.
## Citation
[Include a [CCF file (Citaion File Format)](https://citation-file-format.github.io/). See example in this repo: `CITATION.cff`. You can easily create the content of a CCF using [this tool](https://citation-file-format.github.io/cff-initializer-javascript/). ]
[CCF files can be converted to a multitude of formats, including BibTex, EndNote, codemeta, plain JSON, schema.org, RIS, and Zenodo JSON ]
## Acknowlegdements
[Name anyone who deserves it.]