Skip to content
Snippets Groups Projects
README.md 1.61 KiB
Newer Older
Thomas Hocking's avatar
Thomas Hocking committed
# Title
Choose a title that is likely to be understood by colleagues, students and if possible even the general public and not only those who are experts on the subject

## Overview
A brief general description that allows others to easily understand what your source code is about and to determine if it is useful for their needs.

## Prerequisites
Information about software that users need to use the source code.

## Language
Software language for which the source code is written.

## File description
Provide all information that is necessary for future users to understand your source code files.

## Citation
Shows how the source code should be cited (filled in by database staff).

## References
References to papers that describe the source code.

## Comments
Any additional useful comments. This can e.g. be roles of persons involved in creating the source code.

## Authors
Name of the persons who have developed the source code and who should be named when the code is cited.

## Contact information
Name, affiliation, postal address and email address of the contact person for the source code.

## Publisher
Bolin Centre Code Repository

## Version
Version number of the release for which the indicated DOI is minted (we recommend 1.0.0 for an initial release).

## Project URL
Main URL of the source code project (filled in by database staff).

## DOI
DOI of a particular version of the source code that shall be citable (filled in by database staff).

## License
License under which the source code is distributed.

## Publication date
Date when the version having the indicated DOI was made public (filled in by database staff).