A CITATION.cff file can be added to your GitHub repository to describe the software after it is preserved in Zenodo.
1
Open your repository on GitHub
2
Add a new file
3
Name it CITATION.cff
4
(Optional) Validate the contents of the file, see the instructions below for more information.
5
Commit the file
Currently Zenodo implements a subset of the CITATION.cff schema, find an example with all the fields that are supported below:
cff-version: 1.2.0
title: "Memory bus simulation scripts"
version: 1.8.0
license: "MIT"
type: software
abstract: "These are the scripts used to simulate a memory bus"
message: "If you use this software, please cite it as below."
authors:
- given-names: Josiah
family-names: Carberry
affiliation: Brown University
orcid: "https://orcid.org/0000-0002-1825-0097"
keywords:
- computer science
- psychoceramics
- journaling filesystems
A CITATION.cff can be validated using tools such as cff-convert. Even though this is not maintained by Zenodo, we use it to validate our users' files and it is also recommended by the Citation File Format.
Instructions on how to install and execute the tool can be found on their repository: