Skip to content

Commit e21bf8c

Browse files
Add CITATION.cff and BibTeX to the readme
1 parent 118b9b4 commit e21bf8c

File tree

2 files changed

+39
-0
lines changed

2 files changed

+39
-0
lines changed

CITATION.cff

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
cff-version: 1.2.0
2+
message: "If you find this code helpful, please cite it as below."
3+
title: "robot_descriptions.py: Robot descriptions in Python"
4+
version: 1.8.1
5+
date-released: 2024-01-29
6+
url: "https://github.com/robot-descriptions/robot_descriptions.py"
7+
license: "Apache-2.0"
8+
authors:
9+
- family-names: "Caron"
10+
given-names: "Stéphane"
11+
orcid: "https://orcid.org/0000-0003-2906-692X"
12+
- family-names: "Romualdi"
13+
given-names: "Giulio"
14+
orcid: "https://orcid.org/0000-0002-6461-3231"
15+
- family-names: "Kozlov"
16+
given-names: "Lev"
17+
- family-names: "Ordonez"
18+
given-names: "Daniel"
19+
- family-names: "Tadashi Kussaba"
20+
given-names: "Hugo"
21+
orcid: "https://orcid.org/0000-0002-7336-1443"
22+
- family-names: "Bang"
23+
given-names: "Seung Hyeon"

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,22 @@ New robot descriptions are welcome! Check out the [guidelines](https://github.co
253253

254254
Thanks to the maintainers of all the git repositories that made these robot descriptions available.
255255

256+
## Citation
257+
258+
If you use `robot_descriptions.py` in your scientific works, please cite it *e.g.* as follows:
259+
260+
```bibtex
261+
@software{robot_descriptions_py2024,
262+
author = {Caron, Stéphane and Romualdi, Giulio and Kozlov, Lev and Ordonez, Daniel and Tadashi Kussaba, Hugo and Bang, Seung Hyeon},
263+
license = {Apache-2.0},
264+
month = feb,
265+
title = {{robot_descriptions.py: Robot descriptions in Python}},
266+
url = {https://github.com/robot-descriptions/robot_descriptions.py},
267+
version = {1.8.1},
268+
year = {2024}
269+
}
270+
```
271+
256272
## See also
257273

258274
Robot descriptions in other languages:

0 commit comments

Comments
 (0)