diff --git a/README.md b/README.md index 3a87f17a8de55e93ef6159c3f82c718fcf094c0f..3ef29687e7b24344af031e25815c2f2dc4d2a1c2 100644 --- a/README.md +++ b/README.md @@ -360,3 +360,11 @@ Access the file in NetLogo via the `Included files` dropdown in the Code tab. The file `Model.nlogo` is simply copied from the `nlogo` directory via option `code_files` in the `[paths]` section of the `Yarner.toml`. This separation of model code (`Code.nls`) and user interface (`Model.nlogo`) also allows to edit the model's UI elements in NetLogo's GUI builder tool, while using Literate Programming for the code. + +### Syntax & settings + +The project layout and the syntax used by Yarner (e.g. `;- Name` and `; ==> Macro.`) are configured in the file [`Yarner.toml`](./Yarner.toml). + +### CI / automation + +The code and documentation created from this document is available for [download](https://git.ufz.de/oesa/literate-netlogo/-/jobs/artifacts/main/download?job=build). The downloads are automatically created by the GitLab CI (Continuous Integration) on every push to this repository. This is done by the CI script in [`.gitlab-ci.yml`](./.gitlab-ci.yml).