Commit 4c79874b authored by vuillaut's avatar vuillaut
Browse files

update README information

parent 1eb790d1
# machine-readable-template
# ESCAPE metadata template
Simple repository to provide a machine-readable template for ESCAPE projects
A machine-readable metadata template for ESCAPE projects
There are mandatory and optional fields defined from this [working document](https://cloud.escape2020.de/index.php/s/RGNw7kKABKotBQE)
Please find below the description of the fields.
## Mandatory
- project title
- title: project title
- authors: list of authors
- contact:
- name: could be a person or an entity (e.g. ESCAPE or CTA Observatory)
- email
- description: short description
- keywords: to be selected in a defined list of keywords
- license: open source
- keywords: list of keywords to categories the project. A pre-defined list of keywords is given below.
- license: the open-source project license (e.g. MIT)
## Optional
- Digital Object Identifier (doi)
- publication date (if already published elsewere, leave empty otherwise)
- type of publication: source code, packages, containerized... (complete list TBD)
- type of publication: software, document, image, audio, video, publication, poster, presentation, lesson, other
- grant/funding
- contributors
- references
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment