doc: CITATION.cff (#115)

Generate CITATION.cff file now supported by Github. Closes #114
mmcloughlin · Aug 31, 2021 · cab1a66 · cab1a66
1 parent 908a496
commit cab1a66
Show file tree

Hide file tree

Showing 5 changed files with 44 additions and 2 deletions.
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+message: "If you use addchain in your work, a citation would be appreciated using the following metadata."
+title: "mmcloughlin/addchain: v0.3.0"
+abstract: "Cryptographic Addition Chain Generation in Go"
+authors:
+  - family-names: "McLoughlin"
+    given-names: "Michael Ben"
+    orcid: "https://orcid.org/0000-0003-2347-6258"
+version: "0.3.0"
+date-released: "2021-05-13"
+license: BSD-3-Clause
+repository-code: https://github.com/mmcloughlin/addchain
+doi: "10.5281/zenodo.4758226"
+identifiers:
+  - type: doi
+    value: "10.5281/zenodo.4625263"
+    description: "The concept DOI of the work."
+  - type: doi
+    value: "10.5281/zenodo.4758226"
+    description: "The versioned DOI for version 0.3.0 of the work."
diff --git a/...rnal/tools/docgen/templates/citation.tmpl → internal/tools/docgen/templates/bibtex.tmpl b/...rnal/tools/docgen/templates/citation.tmpl → internal/tools/docgen/templates/bibtex.tmpl
diff --git a/internal/tools/docgen/templates/cff.tmpl b/internal/tools/docgen/templates/cff.tmpl
@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+message: "If you use addchain in your work, a citation would be appreciated using the following metadata."
+title: "mmcloughlin/addchain: {{ .Meta.ReleaseTag }}"
+abstract: "Cryptographic Addition Chain Generation in Go"
+authors:
+  - family-names: "McLoughlin"
+    given-names: "Michael Ben"
+    orcid: "https://orcid.org/0000-0003-2347-6258"
+version: "{{ .Meta.ReleaseVersion }}"
+date-released: "{{ .Meta.ReleaseDate }}"
+license: BSD-3-Clause
+repository-code: https://github.com/mmcloughlin/addchain
+doi: "{{ .Meta.DOI }}"
+identifiers:
+  - type: doi
+    value: "{{ .Meta.ConceptDOI }}"
+    description: "The concept DOI of the work."
+  - type: doi
+    value: "{{ .Meta.DOI }}"
+    description: "The versioned DOI for version {{ .Meta.ReleaseVersion }} of the work."
diff --git a/internal/tools/docgen/ztemplates.go b/internal/tools/docgen/ztemplates.go
diff --git a/script/generate b/script/generate
@@ -25,7 +25,8 @@ bib generate -bib doc/references.bib -type markdown -output doc/bibliography.md
 # Documentation.
 go run ./internal/tools/docgen -type readme -tocmax 3 -output README.md
 go run ./internal/tools/docgen -type results -output doc/results.md
-go run ./internal/tools/docgen -type citation -output CITATION.bib
+go run ./internal/tools/docgen -type cff -output CITATION.cff
+go run ./internal/tools/docgen -type bibtex -output CITATION.bib
 go run ./internal/tools/docgen -type zenodo -output .zenodo.json
 
 # Install script. (Post-processed to remove timestamp for repeatability.)