diff --git a/README.md b/README.md index a56d794..925ab57 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,27 @@ sources. See [index] for an outline of the course material. +## Authoring content + +The content in this repository is processed using [Quarto] in order to +generate the website seen at https://xcitecourse.org/. + +To add content, do this: + +- Download and install Quarto from [quarto.org][Quarto]. +- Clone this repository. +- Add/edit content in the form of `.md`, `.qmd`, or `.ipynb` files. +- Open a terminal, and run `quarto preview`, which will start a local + webserver with a live preview. +- Once you are satisfied with your changes, commit them, and push them + to this repository, or submit a pull request. + +Once content publish workflow will then take care of + [CHESS]: https://www.chess.cornell.edu/ [index]: ./index.md + +[Quarto]: https://quarto.org +[x-cite]: https://xcitecourse.org/