From 7c7b73e65e1a066ee83c0ec400eab1721a48178e Mon Sep 17 00:00:00 2001
From: Sophie Herold <sophie@hemio.de>
Date: Sun, 18 Feb 2024 14:21:02 +0100
Subject: [PATCH] help: Add README

---
 help/README.md | 3 +++
 1 file changed, 3 insertions(+)
 create mode 100644 help/README.md

diff --git a/help/README.md b/help/README.md
new file mode 100644
index 0000000..0d80b81
--- /dev/null
+++ b/help/README.md
@@ -0,0 +1,3 @@
+# Loupe Help
+
+The help pages are currently written in [ducktype](http://projectmallard.org/ducktype/1.0/index.html). The files are stored in `help/C/duck` and the corresponding `.page`-files can be generated via `make -C help/C`. Afterwards, you can preview the generated help pages via `yelp help/C/index.page`. The generated `.page`-files have to be committed to the repository as well. The `ducktype` program required for running `make` is probably packaged in you distro and is also [availabe on GitHub](https://github.com/projectmallard/mallard-ducktype).