Link to your zenodo DOI as follows:
Link to any figshare resources as follows:
Describe your software in one paragraph. Explain its application, what it can do and who should use it.
SOFTWARE_TEMPLATE is an example repository and serves as a guide to new and existing projects to help your project apply software best practices. This repository follows CIG software best practices and is a companion to its contribution checklist.
The checklist and this repository is meant as a guide to prepare your software for CIG review.
The project is supported by Computational Infrastructure for Geodynamics (CIG) which is supported by the National Science Foundation award NSF-0949446 and NSF-1550901 (http://geodynamics.org).
Either refer to theINSTALL file or link to another place where you keep installation instructions.
This repository contains no code or executable files.
Refer to where the user can find instructions on how to run and modify the software. We also recommend adding a quick-start guide here.
New projects should begin by placing a copy of this repository into your project repository and modifying the contents of each file as appropriate.
Include information about how to cite SOFTWARE_TEMPLATE. Consider adding citations to both publications and the software itself. For examples, see: https://geodynamics.org.
We also recommend adding a codemeta file (codemeta.json). Generate this file to make your code citable:https://codemeta.github.io/codemeta-generator/.
SOFTWARE_TEMPLATE is free to use and does not require citation or acknowledgement.
Describe how to contribute to the project. Consider pointing to a CONTRIBUTING.MD FILE.
SOFTWARE_TEMPLATE is a community project that lives by the participation of its members — i.e., including you! It is our goal to build an inclusive and participatory community so we are happy that you are interested in participating! We have collected a set of guidelines and advice on how to get involved in the community and keep them in the CONTRIBUTING.md file in the repository.
Explain how a user should provide feedback, report bugs, and get help.
For support, see our forum at: https://community.geodynamics.org/.
To contribute to this project, see CONTRIBUTING.md.
Include links where to find additional information, such as:
The official website at ...The current manual at ...Any upstream projects you would like to acknowledgeNames and email addresses of the maintainers and/or AUTHORSIf you have specific questions about our software that are not suitable for public and archived mailing lists, feel free to contact the maintainers or principal developers.
For more information about the Computational Infrastructure for Geodynamics, please see our website at: geodynamics.org.
States the license type and links to the full LICENSE file.
This SOFTWARE_TEMPLATE is published under the MIT license.