aboutsummaryrefslogtreecommitdiff
path: root/hugo/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'hugo/README.md')
-rw-r--r--hugo/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/hugo/README.md b/hugo/README.md
new file mode 100644
index 0000000..70c53a0
--- /dev/null
+++ b/hugo/README.md
@@ -0,0 +1,15 @@
+# Static website
+www.sigsum.org can be generated as a static website using [hugo](https://gohugo.io)
+and the [hugo-xmin](https://github.com/yihui/hugo-xmin) theme.
+
+## One-time setup
+1. Install `hugo`
+1. Initialize theme: `git submodule update --init --recursive`
+
+## Test locally
+1. Run `hugo serve`
+2. Browse http://localhost:1313
+
+## Generate
+1. Run `hugo`
+2. Static website is now located in `public`