From a7c009d6c0403e50359c5015b1aeb1c9243ff64a50466cb88f767ecbc748ee1f Mon Sep 17 00:00:00 2001
From: Nicholas Johnson <>
Date: Sat, 9 Aug 2025 00:00:00 +0000
Subject: Add README with howto

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

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0cdbfe8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Journal
+
+The live Gemini capsule is available at [gemini://nicholasjohnson.ch](gemini://nicholasjohnson.ch).
+
+The live website is available at [https://nicholasjohnson.ch](https://nicholasjohnson.ch).
+
+## Generate Locally
+
+### Required Software
+
+- git
+- git annex
+- hugo
+
+### Commands
+
+```sh
+git clone --recursive https://git.nicholasjohnson.ch/journal && cd journal
+git branch --track git-annex origin/git-annex
+git annex pull  # this may take some time
+hugo -e gemini  # generate capsule in directory "public/capsule"
+hugo -e web     # generate website in directory "public/website"
+```
-- 
cgit v1.2.3