search

b2-hive / eFFORT

Tools for reweighting semileptonic B decays
MIT License
3 stars 7 forks source link

Add `CITATION.cff` file #22

Open meliache opened 3 years ago

meliache commented 3 years ago

This would enable the citation in github, see this tweet by the twitter CEO: https://twitter.com/natfriedman/status/1420122675813441540 and the homepage of the citation file format: https://citation-file-format.github.io/.

For example:

cff-version: 1.1.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Prim
    given-names: Markus Tobias
    orcid: https://orcid.org/0000-0002-1407-7450
title: "b2-hive/eFFORT"
version: 0.1.0 
doi: 10.5281/zenodo.3965698
date-released: 2017-12-18
MarkusPrim commented 3 years ago

cool thanks! I will merge this and also add this to the new version 2 repo when it becomes public :)

meliache commented 3 years ago

I could have also just done a PR :sweat_smile: . But for citation information I thought it might be better if I leave it to the authors.

When I saw the news of this citation feature eFFORT was the first or our group's packages that came to my mind where this could be used.

meliache commented 3 years ago

Note: There is now also official github documentation for this feature, which is a bit more substantial than just a tweet.