Skip to content

Add CITATION.cff file#900

Merged
mhucka merged 2 commits intoquantumlib:mainfrom
mhucka:mh-add-citation-cff
Mar 15, 2025
Merged

Add CITATION.cff file#900
mhucka merged 2 commits intoquantumlib:mainfrom
mhucka:mh-add-citation-cff

Conversation

@mhucka
Copy link
Copy Markdown
Contributor

@mhucka mhucka commented Mar 15, 2025

A file in CITATION File Format (CITATION.cff) can be placed at the top level of a GitHub repo to provide machine-readable citation information that helps users correctly cite software. When it detects a CITATION.cff file in a repository, GitHub adds a button to the upper right sidebar that lets users copy a formatted citation.

I generated this particular CITATION.cff file mostly by hand, with a little initial help from Citation.js.

@Strilanc the abstract and the list of keywords could use a review. I gave it a good try but there may still be errors.

@mhucka mhucka marked this pull request as ready for review March 15, 2025 03:25
@mhucka mhucka enabled auto-merge (squash) March 15, 2025 03:26
@mhucka mhucka requested a review from Strilanc March 15, 2025 03:26
@mhucka mhucka merged commit cae4e9f into quantumlib:main Mar 15, 2025
56 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant