diff options
| author | Nicholas Johnson <> | 2025-08-09 00:00:00 +0000 |
|---|---|---|
| committer | Nicholas Johnson <> | 2025-08-11 00:00:00 +0000 |
| commit | a7c009d6c0403e50359c5015b1aeb1c9243ff64a50466cb88f767ecbc748ee1f (patch) | |
| tree | aba9c106f4e315348a2030cc9bf19c876b83854021cf12191c901808ed846b4a | |
| parent | 0c6dab1deecac50683de4cbd0c98b1a816663df73578988eacf007203d652b1b (diff) | |
| download | journal-a7c009d6c0403e50359c5015b1aeb1c9243ff64a50466cb88f767ecbc748ee1f.tar.gz journal-a7c009d6c0403e50359c5015b1aeb1c9243ff64a50466cb88f767ecbc748ee1f.zip | |
Add README with howto
| -rw-r--r-- | README.md | 23 |
1 files changed, 23 insertions, 0 deletions
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" +``` |