aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md19
1 files changed, 18 insertions, 1 deletions
diff --git a/README.md b/README.md
index af63d42..5be2ba6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,19 @@
# rgdd.se
-TODO: docdoc.
+This website is built using [Hugo](https://gohugo.io/) and the
+[gruvhugo](https://gitlab.com/avron/gruvhugo) theme. It is deployed on a VPS.
+
+## Quick start after cloning
+1. Run `git submodule update --init --recursive`
+2. Follow the instruction [here](https://gohugo.io/getting-started/installing/#fetch-from-github)
+to install extended Hugo.
+3. Try serving the website locally
+ 1. Run `hugo serve`
+ 2. Browse http://localhost:1313
+
+## Create a new post
+Blog posts live in the `content/post` directory. You can use Hugo to generate
+a basic template (`hugo new posts/mypost.md`), or peak at a previous post.
+
+## Generate a new website that can be published
+1. Check that it runs as expected locally (see quick start, step 3).
+2. Run `hugo`. This will update the `public` repository that is deployed somewhere.