Skip to content

Commit

Permalink
Update README.rst (#165)
Browse files Browse the repository at this point in the history
* Update README.rst

* Update README.rst

fix citation

* Create CITATION.cff

* add Jorgen as main author
* add doi
* see: https://citation-file-format.github.io/
* see: https://github.com/citation-file-format/citation-file-format
* see: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

* change CITATION.cff to CITATION.bib

- update citation to latest version 0.16.0 - how to maintain this? have to update every time?
- update to use zenodo catch-all DOI 10.5281/zenodo.7746009 which always points to latest version
- watch out! zenodo may use the CITATION.cff to infer metadata about sphinx-contrib MATLAB domain, how will this affect the citation? Currently zenodo lists all contributors as authors, which I think is preferred, therefore change to .bib to avoid zenodo parsing
  • Loading branch information
mikofski authored Mar 18, 2023
1 parent f342fac commit 9102348
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 0 deletions.
27 changes: 27 additions & 0 deletions CITATION.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
@software{jorgen_cederberg_2023_7747374,
author = {Jørgen Cederberg and
Mark Mikofski and
jcewidex and
Denis Rosset and
Isaac Lenton and
Neururer Martin and
Mathew Topper and
Chris Markiewicz and
Christoph Boeddeker and
Claudio Vergari and
cleobis and
David Stansby and
florianjacob and
PekaryGergelyR and
Hugo Leblanc and
Marc-Henri Bleu-Laine and
Nikolaas N. Oosterhof and
ptitrex},
title = {sphinx-contrib/matlabdomain: 0.16.0},
month = mar,
year = 2023,
publisher = {Zenodo},
version = {0.16.0},
doi = {10.5281/zenodo.7746009},
url = {https://github.com/sphinx-contrib/matlabdomain}
}
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -245,3 +245,9 @@ Users
* `CoSMo MVPA <http://cosmomvpa.org/download.html?highlight=matlabdomain#developers>`_
* `The Cobra Toolbox <https://opencobra.github.io/cobratoolbox/stable/index.html#>`_
* `The RepLAB Toolbox <https://replab.github.io/replab>`_


Citation
========
.. image:: https://zenodo.org/badge/105161090.svg
:target: https://zenodo.org/badge/latestdoi/105161090

0 comments on commit 9102348

Please sign in to comment.