add example content, compile to site and pdf

1 files changed, 20 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..1645cf6
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,20 @@
+# Markdown course website example / template
+
+This is an example of course website, divided into two parts: lectures and
+exercises sheets.
+
+Everything is generated from Markdown source files into static files which can
+then be served through by any web server.
+
+For convenience, the compilation and deployment can be automated through GitLab
+CI or equivalent, which allows automatic publication of the latest version
+after pushing the sources to a version-controlled repository for example.
+
+
+## Resources and references
+
+- [Markdown syntax](https://daringfireball.net/projects/markdown/syntax)
+- [Quarto (reference)](https://quarto.org/docs/reference/index.html)
+- [Pandoc (manual)](https://pandoc.org/MANUAL.html)
+- [Nix guides](https://nixos.org/learn.html)
+- [GitLab CI configuration reference](https://docs.gitlab.com/ee/ci/yaml/)