Added citation metadata file #3409
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This adds
CITATION.cffto the repo. This is a yaml file specified by: https://citation-file-format.github.io/. The advantage of having this is that things like Github, Zenodo, and Zotero can cite the repo more easily. For this I took the CFF file created by Zenodo, and added the preferred citation article as well to the file.For an example of it working see the right hand side of the GH with this branch
Fixes #3408
Checklist
I have performed a self-review of my own codeI have run clang-format (version 15) on any C++ source files (if applicable)I have followed the style guidelines for Python source files (if applicable)I have added tests that prove my fix is effective or that my feature works (if applicable)