From 808012b4f0dcc42fac9aa3c8c380b1c65c7ed156 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?benjamin=20melan=C3=A7on?= <ben@agaric.com>
Date: Tue, 31 Jul 2018 21:51:16 -0400
Subject: [PATCH] Add instructions for getting styleguidegit submodule

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

diff --git a/README.md b/README.md
index e69de29..f34ccea 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,24 @@
+## Get submodules
+
+This project includes the [Agaric styleguide](https://gitlab.com/agaric/styleguide) as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
+
+### When cloning
+
+```
+git clone --recurse-submodules git@gitlab.com:agaric/sites/agaric-com.git
+```
+
+### If you cloned without `--recurse-submodules`
+
+If in your initial clone you didn't do as above, you can get the styleguide with:
+
+```
+git submodule init
+git submodule update
+```
+
+### Get updates
+
+```
+git submodule update --recursive --remote
+```