Skip to content

Commit 7535642

Browse files
committed
🎨 add default citation
1 parent 720cc6f commit 7535642

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

CITATION.cff

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
2+
cff-version: 1.2.0
3+
message: "If you use this software, please cite it as below."
4+
authors:
5+
- family-names: "Last"
6+
given-names: "First"
7+
orcid: "https://orcid.org/0000-0000-0000-0000"
8+
title: "Python Package Template repository"
9+
version: 0.0.1
10+
doi: 10.5281/zenodo.1234
11+
date-released: 2025-07-23
12+
url: "https://github.com/biosustain/python_package"

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ see [GitHub documentation](https://docs.github.com/en/repositories/creating-and-
1111
You will need to find and replace occurences of
1212

1313
- `python_package` -> `your_package_name`
14-
- also the folder `src/python_package`
14+
- also the folder `src/python_package`
1515
- `RasmussenLab` -> `GitHub_user_name` (or `organization`)
16-
with the name of your package and GitHub user name (or organization).
16+
with the name of your package and GitHub user name (or organization).
1717

1818
- look for `First Last` to see where to replace with your name
1919
- choose a license, see [GitHub documentation](https://docs.github.com/en/repositories/creating-and-managing-repositories/licensing-a-repository)
2020
and [Creative Commons](https://creativecommons.org/chooser/).
2121
Replace [`LICENSE`](LICENSE) file with the license you choose.
22+
- Update the `CITATION.cff` file with your information.
2223

2324
## Development environment
2425

@@ -41,7 +42,7 @@ print(hello_world(4))
4142
## Readthedocs
4243

4344
The documentation can be build using readthedocs automatically. See
44-
[project on Readthedocs](https://readthedocs.org/projects/rasmussenlab-python-package/)
45+
[project on Readthedocs](https://readthedocs.org/projects/rasmussenlab-python-package/)
4546
for the project based on this template. A new project needs
4647
to [be registered on ReadTheDocs](https://docs.readthedocs.com/platform/stable/intro/add-project.html).
4748

0 commit comments

Comments
 (0)