diff options
author | Rasmus Dahlberg <rasmus.dahlberg@kau.se> | 2021-09-25 22:18:10 +0200 |
---|---|---|
committer | Rasmus Dahlberg <rasmus.dahlberg@kau.se> | 2021-09-25 22:18:10 +0200 |
commit | 2a38ea5028f33bd919cedf621f82d8fe7827273c (patch) | |
tree | 3bb33695753a73623a8f80747631851518a1d043 | |
parent | 5784e1ab51faa71834338b6e733b9aad4e6f46eb (diff) |
added a brief README file
-rw-r--r-- | README.md | 19 |
1 files changed, 18 insertions, 1 deletions
@@ -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. |