From 516e9bcd729134b99208f4e4ce5dfaf33a49dc71 Mon Sep 17 00:00:00 2001
From: Oliver Hamlet <oliver@ortham.io>
Date: Tue, 23 Aug 2022 19:48:12 +0100
Subject: [PATCH] Add build instructions to readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/README.md b/README.md
index cd19bbf..656c7fb 100644
--- a/README.md
+++ b/README.md
@@ -4,3 +4,19 @@ loot.github.io
 This repository acts as the main LOOT team repository, and holds all the issues that aren't specific to the code or any one game. In addition to that, it also holds LOOT's static website.
 
 The static website is a [Jekyll](https://jekyllrb.com/) site that uses [Material Design Lite](https://www.getmdl.io/) components and the [js-yaml](https://github.com/nodeca/js-yaml) and [Github.js](https://github.com/michael/github) libraries, which are provided by Google, Cloudflare and unpkg CDNs respectively.
+
+The easiest way to build this site locally is using Docker:
+
+```
+docker run --rm -v ${PWD}:/srv/jekyll -v jekyll_bundle:/usr/local/bundle -p 4000:4000 -it jekyll/jekyll:3.8.6 jekyll serve --no-watch
+```
+
+The site will then be accessible at <http://localhost:4000>.
+
+To update the `github-pages` Ruby gem, run:
+
+```
+docker run --rm -v ${PWD}:/srv/jekyll -v jekyll_bundle:/usr/local/bundle jekyll/jekyll:3.8.6 bundle update github-pages
+```
+
+The version used by GitHub is given [here](https://pages.github.com/versions/).