Commit d5deaac
Changed files (1)
README.md
@@ -0,0 +1,37 @@
+# www.git
+
+This is the content and scripts that build [www.intermittent.network](https://www.intermittent.network).
+
+## Get your own copy
+
+This website, as the domain name suggests, is not intended to be fully reliable. If you are interested
+in any of the content, you're strongly encoraged to download a copy for yourself.
+
+You can clone this repository by running:
+
+```
+git clone https://www.intermittent.network/git/www.git
+```
+
+The blog content is in `blog`; other directories are mostly configuration stuff that is unlikely to be
+directly applicable to anyone other than me.
+
+# Building the website
+
+You probably don't need to do this, but just in case:
+
+ 1. Fetch git submodules (bear theme)
+ 1. Install dependencies: `hugo`, `gitmal`, `brotli`, `zstd` and the usual command line utilities
+ 1. cd to a directory outside the repo. Note that any directory named `root` will be blown away,
+ so probably create a new empty directory.
+ 1. Run `/path/to/build.sh` and `root` will be populated with a set of files ready to be blatted
+ onto the root filesystem of an appropriately prepared FreeBSD jail.
+
+## Deploying
+
+This is "note to self" territory:
+ - copy to server
+ - deploy to www jail
+ - reload nginx in www jail
+ - issue (hopefully soft) purge of `blog` and/or `git` tags to Fastly with `~/softpurge.sh blog` etc.
+ - hopefully everything just works?