Skip to content

Commit b4e1aa2

Browse files
docs: add Turing Way links for CITATION.cff and software citation
Adds links to The Turing Way guides on CITATION.cff files and software citation pathways in the license/citation section. Closes #562
1 parent 743ab87 commit b4e1aa2

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

documentation/repository-files/license-files.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,13 @@ This would not be true with a GPL licensed package. `GPL-3` packages can include
132132

133133
While many permissive licenses do not require citation, we strongly encourage that you cite all software that you use in papers, blogs, and other publications. You tell your users how to cite your package by using a [citation.cff file](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files).
134134

135+
:::{tip} Additional resources on software citation
136+
The Turing Way has excellent guides on this topic:
137+
138+
- [CITATION.cff files](https://book.the-turing-way.org/communication/citable/citable-cff) — detailed guide on creating and maintaining citation files
139+
- [Software citation pathways](https://book.the-turing-way.org/pathways/pathways-software-citation) — overview of how software citation works in practice
140+
:::
141+
135142
### Citation.cff files: Making your software citable
136143

137144
A `CITATION.cff` file is a machine-readable file that provides citation information for your software package. The "cff" stands for "Citation File Format," which is a standardized format for software citation metadata.

0 commit comments

Comments
 (0)