aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index fbdf5c7..9d16175 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,7 @@ This website is built using [Hugo](https://gohugo.io/) and the
[researcher](https://github.com/ojroques/hugo-researcher) theme.
## Quick start after cloning
+
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.
@@ -10,6 +11,19 @@ to install extended Hugo.
1. Run `hugo serve`
2. Browse http://localhost:1313
+## Updating the theme
+
+If the local submodule is behind, run:
+
+ git submodule update
+
+## Upgrading the hugo-theme submodule
+
+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.