1 files changed, 17 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ae0df5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# My cgit configuration
+
+This repository contains all the files needed to configure my
+[cgit](https://git.zx2c4.com/cgit/about) instance:
+
+* `cgitrc`: the main configuration file.
+* `custom/README.html`: the content of the main "About" page, generated
+  manually from `custom/README.md`.
+* `custom/about-filter.sh`: custom filter for README pages.
+* Other files in `custom/`: various static content (pictures, HTML
+  snippets) used to build the pages.
+
+For testing locally, you can use `lighttpd.conf` (but first change it to
+match your username!). The script `deploy.sh` can be used to push the
+files to the correct folder, either locally or remotely. This works on
+Alpine Linux, the paths may vary for other distros. See also
+[Alpine Linux Wiki - Cgit](https://wiki.alpinelinux.org/wiki/Cgit).