From 75f3f0b70df5a634a4b8f4f0eae2bd45d8f3224a Mon Sep 17 00:00:00 2001 From: "Tristan B. Velloza Kildaire" Date: Sun, 9 Jul 2023 21:11:04 +0200 Subject: [PATCH] - Added notes on contributing --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index a76ffc0..a9b298c 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,19 @@ mkdocs serve ``` In the root of the repository, if you get an error you will need to install some PIP dependencies. + +## Contributing + +If you would like to edit the documentation then please edit the files in `docs_src/` (and **NOT** in `docs/`). The former folder +is used for the base documentation files and the latter is the result of the post-processing needed to be applied to the Markdown +files before they can be used for generating the LaTeX-based book or the Mkdocs website. + +Once you have finished making your changes in the files in `docs_src/`, please then run the post-processing script: + +```bash +./makemarkdown.sh +``` + +This should produce an updated file in `docs/` with the same name as the one you edited in `docs_src/`, **commit BOTH files** please. + +Then you're done! \ No newline at end of file