aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRasmus Dahlberg <rasmus@rgdd.se>2024-05-04 18:17:43 +0200
committerRasmus Dahlberg <rasmus@rgdd.se>2024-05-04 18:17:43 +0200
commit86adcabfa795fa83c492ad9f05261036df6fcbff (patch)
tree8cd6be20d342b1b4c809dc83b34da6d4af2d74e9
parentb8523ea163dcc57e320b7607cbe0ca8315d56fbe (diff)
Bring README up to date
-rw-r--r--README.md45
1 files changed, 24 insertions, 21 deletions
diff --git a/README.md b/README.md
index 9d16175..eaf104c 100644
--- a/README.md
+++ b/README.md
@@ -1,34 +1,37 @@
-# rgdd.se
-This website is built using [Hugo](https://gohugo.io/) and the
-[researcher](https://github.com/ojroques/hugo-researcher) theme.
+# www.rgdd.se
-## Quick start after cloning
+This website is built using [Hugo][] and a [fork][] of the [researcher][] theme.
-1. Run `git submodule update --init --recursive`, then apply themes patch.
-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
+[Hugo]: http://localhost:1313/
+[fork]: https://git.rgdd.se/www-theme
+[researcher]: https://github.com/ojroques/hugo-researcher
-## Updating the theme
+## Getting started
-If the local submodule is behind, run:
+On a Debian system:
- git submodule update
+ apt install hugo
+ git submodule update --init --recursive
+ hugo serve
+
+Browse http://localhost:1313 for a preview of the site.
+
+## Deploy
+
+ hugo
+ rsync -avz --delete public www.rgdd.se:/var/www/rgdd.se
-## Upgrading the hugo-theme submodule
+Note: old files will be deleted, use with caution.
+
+## Upgrade theme
If the remote submodule contains updates, run:
(cd themes/www-theme && git checkout main && git pull origin main)
git add themes/www-theme
-## Create a new post
-Blog posts live in the `content/post` directory. You can use Hugo to generate
-a basic template (`hugo new post/mypost.md`), or peak at a previous post.
+## Sync theme
+
+If the local submodule is behind, run:
-## 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.
-3. `rsync -r public/* nemo:/var/www/rgdd.se/`
+ git submodule update