diff --git a/README.md b/README.md index 58f7501..04c81b4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ # Tutorial Template -This repo serves as the template/basis for our Quarto tutorials. \ No newline at end of file +This repo serves as the template/basis for our Quarto tutorials. + +## Check `CITATION.cff` Format + +Repo templates come with a GitHub Action that will check that the `CITATION.cff` file is correctly formatted every time the file is pushed to GitHub (and it will check on any branch to which it is pushed.) + +You can also run this check locally with the code below which 1) installs the `cffconvert` checker package, and runs the check (inside of a Docker container). You may need to install Docker and Python 3 if they are not already on your computer. + + +```{bash} +python3 -m pip install --user cffconvert +docker run --rm -v "${PWD}:/app" citationcff/cffconvert --validate +```