Skip to content

Commit 49daa6e

Browse files
committed
add developers.md
1 parent 9807066 commit 49daa6e

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/developers.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Notes for developers
2+
3+
### How to check the .cff file
4+
5+
You can validate the `CITATION.cff` file with the command:
6+
```bash
7+
cffconvert --validate
8+
```
9+
10+
You can install the script `cffconvert` with the command:
11+
```bash
12+
python3 -m venv venv
13+
source venv/bin/activate
14+
python3 -m pip install cffconvert
15+
```
16+
After using the tool, deactivate the Python environment with:
17+
```bash
18+
deactivate
19+
```

0 commit comments

Comments
 (0)