diff options
| -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" +``` |