summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNick White <git@njw.name>2021-03-16 14:44:56 +0000
committerNick White <git@njw.name>2021-03-16 14:44:56 +0000
commit9ebedc0d4e6a5e40c21109cfc1254105ee1e6ebb (patch)
treed16a77f63e45cc82f3d5da8a9b222f0654fd4e3c /README
parent3f6c8791d7b91de80eecf46b462a765aeb168b88 (diff)
Add README and deploy script
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..b514922
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+# Rescribe blog
+
+This is the source for the Rescribe blog. It is built with Hugo,
+so all page content is in content/, and as a convention any image
+source files are stored in images/.
+
+## Submodules
+
+The theme for the website is stored as a git submodule. On checking
+out this repository, run these to fetch it:
+
+git submodule init
+git submodule update
+
+This is done so that we can keep our branch of the theme easily up
+to date with upstream.
+
+## Deploying
+
+deploy.sh builds and deploys the website.