From fecf345e1133fccec2e174f9b618b8c3772655e0 Mon Sep 17 00:00:00 2001
From: Jools Wills <buzz@exotica.org.uk>
Date: Thu, 28 Sep 2017 08:34:45 +0100
Subject: [PATCH] added a note in the docs regarding git submodules

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

diff --git a/README.md b/README.md
index ecb5307e0..a17dcf6a6 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,20 @@ sudo apt-get install libsdl2-dev libboost-system-dev libboost-filesystem-dev lib
   libvlc-dev libvlccore-dev vlc-nox
 ```
 
+Note this Repository uses a git submodule - to checkout the source and all submodules, use
+
+```bash
+git clone --recursive https://github.com/RetroPie/EmulationStation.git
+```
+
+or 
+
+```bash
+git clone https://github.com/RetroPie/EmulationStation.git
+cd EmulationStation
+git submodule init --update
+```
+
 Then, generate and build the Makefile with CMake:
 ```bash
 cd YourEmulationStationDirectory