Merge pull request #43 from scientificcomputing/finsberg/sofware-citation

Add page about citing software

Author: finsberg

.cspell_dict.txt

@@ -10,6 +10,7 @@ Cookiecutter
 Daversin
 docname
 docnames
+DOLFINx
 Dokken
 electrodiffusive
 finsberg
@@ -18,7 +19,9 @@ Forsch
 Fouilloux
 Gjerde
 glymphatic
+Graphnics
 Haubner
+howpublished
 htmlcov
 importlib
 Ingeborg
@@ -58,5 +61,3 @@ SVMTK
 Valnes
 venv
 Zenodo
-DOLFI
-Graphnics

docs/_toc.yml

@@ -40,6 +40,7 @@ parts:
   - caption: Miscellaneous
     chapters:
     - file: license
+    - file: software-citation
     - file: resources
     - file: misc
 

docs/software-citation.md

@@ -0,0 +1,14 @@
+# Citing a repository
+
+Sometimes you need to cite some software that you used to generate results in a paper. If the software contains instructions for how to cite it then you should use those instructions. For example, the repository might contain a [`CITATION.cff` file](gh-citable.md), see e.g https://github.com/finsberg/ldrb or it might contain instructions for how to cite the software in the README, see e.g https://github.com/ComputationalPhysiology/simcardems/blob/main/README.md#citing
+
+If no instructions exists you should use the `@misc` entry, e.g
+```
+@misc{Finsberg_MPS_motion,
+author = {Finsberg, Henrik},
+title = {{MPS motion - Library for tracking motion in cardiac mps data}},
+howpublished = {\url{https://github.com/ComputationalPhysiology/mps-motion}},
+note = {Accessed: 2022-10-06},
+year = {2022}
+}
+```