From b1b3c46c04079919c284e422f06cad8093bbc00f Mon Sep 17 00:00:00 2001
From: Rien Maertens <rien.maertens@posteo.be>
Date: Sat, 29 Dec 2018 18:00:20 +0100
Subject: [PATCH] Document submodule usage in README

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

diff --git a/README.md b/README.md
index 8c16141..7469496 100644
--- a/README.md
+++ b/README.md
@@ -45,6 +45,14 @@ bundle exec nanoc live
 
 Go to <http://localhost:3000> to view the site! When developing, the site gets regenerated when editing files. A simple refresh will show the new changes.
 
+### Optional: install submodules
+
+Our official meeting reports are added as a submodule so they update automatically. For normal development, it is not required to initialize these. But if you want to deploy to production (or test the report generation), you will have to initialize the submodule.
+
+```bash
+git submodule update --init --recursive
+```
+
 ### Deploying
 
 The latest and greatest builds on master get deployed automatically using [travis](https://travis-ci.org).