From 841f76ec37c2afde3b7e575d9d1497bfe2672d00 Mon Sep 17 00:00:00 2001
From: Andrew Schwartzmeyer <andschwa@microsoft.com>
Date: Tue, 12 Apr 2016 16:16:17 -0700
Subject: [PATCH] Update Git setup documentation

Now that everyone needs all the submodules. Much simpler.
---
 README.md                     | 32 +++++++++++++++++++++++++++++---
 docs/building/linux.md        | 10 +---------
 docs/building/windows-core.md | 10 +---------
 3 files changed, 31 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index b57ca8598d..22c7170827 100644
--- a/README.md
+++ b/README.md
@@ -68,6 +68,32 @@ rules, and Git best practices.
 
 Clone this repository. It is a "superproject" and has a number of
 other repositories embedded within it as submodules. *Please* see the
-contributing guidelines and learn about submodules. Not every
-submodule is required on every system; see the individual build
-instructions for the necessary subsets.
+contributing guidelines and learn about submodules. To make things
+easy, we can just clone recursively.
+
+```sh
+git clone --recursive https://github.com/PowerShell/PowerShell.git
+```
+
+You can verify that the submodules were initialized properly with:
+
+```sh
+git submodule status
+```
+
+If they're initialized, it will look like this:
+
+```
+ f23641488f8d7bf8630ca3496e61562aa3a64009 src/Modules/Pester (f23641488)
+ c99458533a9b4c743ed51537e25989ea55944908 src/libpsl-native/test/googletest (release-1.7.0)
+ e6bf85694ae8352d77175c4c7d304946e018808c src/windows-build (monad/cc6afbeb-3/31)
+```
+
+If they're not, there will be minuses in front (and the folders will
+be empty):
+
+```
+-f23641488f8d7bf8630ca3496e61562aa3a64009 src/Modules/Pester (f23641488)
+-c99458533a9b4c743ed51537e25989ea55944908 src/libpsl-native/test/googletest (release-1.7.0)
+-e6bf85694ae8352d77175c4c7d304946e018808c src/windows-build (monad/cc6afbeb-3/31)
+```
diff --git a/docs/building/linux.md b/docs/building/linux.md
index 88275f544a..5e4076f7ed 100644
--- a/docs/building/linux.md
+++ b/docs/building/linux.md
@@ -59,17 +59,9 @@ Git Setup
 ---------
 
 Using Git requires it to be setup correctly; refer to the
+[README](../../README.md) and
 [Contributing Guidelines](../../CONTRIBUTING.md).
 
-Please clone the superproject (this repo) and initialize a subset of
-the submodules:
-
-```sh
-git clone https://github.com/PowerShell/PowerShell.git
-cd PowerShell
-git submodule update --init -- src/windows-build src/Modules/Pester src/libpsl-native/test/googletest
-```
-
 Build using our module
 ======================
 
diff --git a/docs/building/windows-core.md b/docs/building/windows-core.md
index c4821468e9..31def61ac7 100644
--- a/docs/building/windows-core.md
+++ b/docs/building/windows-core.md
@@ -47,17 +47,9 @@ Git Setup
 ---------
 
 Using Git requires it to be setup correctly; refer to the
+[README](../../README.md) and
 [Contributing Guidelines](../../CONTRIBUTING.md).
 
-Please clone the superproject (this repo) and initialize a subset of
-the submodules:
-
-```sh
-git clone https://github.com/PowerShell/PowerShell.git
-cd PowerShell
-git submodule update --init -- src/windows-build src/Modules/Pester
-```
-
 Build using our module
 ======================