-
-
Notifications
You must be signed in to change notification settings - Fork 88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Suggestion: add CITATION.cff #172
Comments
Hello, Thank you for the suggestion, it sure seems like a good way to handle citing, I will add it in the near future. Best regards, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
GitHub supports CFF files which facilitate citing software: you can download BibTex file right from the repository page; and in general it seems to become the common place to put the relevant info instead (or in addition to) README.
For VkFFT, this would be a
CITATION.cff
file in the repo root with something like:This is just an example, you can use online generator to modify it or refer to the format schema.
Note, that the "preferred citation" field is not quite supported by the online generator, but works fine on GitHub: see e.g. https://github.com/ExtremeFLOW/neko ("Cite this repository" in the right sidebar). I also used git tag instead of the commit hash for
commit
: it works well, and it's easier to update when making a new release.The text was updated successfully, but these errors were encountered: