feat: add citation file #111
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
meyers-academic
approved these changes
Nov 27, 2025
Collaborator
|
Go ahead and add the badge :). I think maybe pointing to the global DOI is better, but we could also update the readme each time, for example is that the idea? And so if you download an old release it will tell you to cite that one? |
davecwright3
force-pushed
the
feat/citation-file
branch
from
804a0ed to
aeed559
Compare
Collaborator
Author
|
I changed the DOI to the global DOI, and added the badge (also global DOI). It's on a new line below the first heading in the README. The rich preview of the diff should render it. |
This will automatically hook into GitHub's "cite this repository" feature.
davecwright3
force-pushed
the
feat/citation-file
branch
from
aeed559 to
a79fa46
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This will automatically hook into GitHub's "cite this repository" feature.
This links to the current version. I could change the doi to point to the "global" zenodo record if that is preferred.
We could also add a badge to the README like the following