Skip to content

chore: add CITATION.cff file#10732

Merged
Ericson2314 merged 1 commit intoNixOS:masterfrom
drupol:add-citation-cff
May 17, 2024
Merged

chore: add CITATION.cff file#10732
Ericson2314 merged 1 commit intoNixOS:masterfrom
drupol:add-citation-cff

Conversation

@drupol
Copy link
Copy Markdown
Contributor

@drupol drupol commented May 17, 2024

Hello,

I frequently need to cite Nix in the documents I write, and noticed that GitHub supports a specific citation file format (CITATION.cff). Having this file would enhance the visibility and proper citation of Nix directly from the GitHub repository page.

GitHub's support for the CITATION.cff files enables easy access to citation information, which can be automatically parsed and displayed on the project page. More details can be found in the GitHub documentation on citation files.

When Github detect such a file in a repo, a new link is displayed on the right side:

image

See it lively at https://github.com/drupol/nix/tree/add-citation-cff

@drupol drupol requested a review from edolstra as a code owner May 17, 2024 15:30
Copy link
Copy Markdown
Member

@Ericson2314 Ericson2314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good to me. We can bikeshed the text later.

url: 'https://nixos.org/'
abstract: >-
Nix, a purely functional package manager, is a powerful
package manager for Linux and other Unix systems that
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hopefully not just Unix soon ;)

@Ericson2314 Ericson2314 merged commit beb3c2b into NixOS:master May 17, 2024
@drupol drupol deleted the add-citation-cff branch May 18, 2024 08:26
@drupol
Copy link
Copy Markdown
Contributor Author

drupol commented May 18, 2024

Thank you for your reactivity, much appreciated.

I wish we could have a DOI for the PHD thesis, but I couldn't find one. I know that https://zenodo.org/ is able to deliver DOI when uploading a document, maybe this is something to think. WDYT @edolstra ?

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.

2 participants