Update Git setup documentation

Now that everyone needs all the submodules. Much simpler.
This commit is contained in:
Andrew Schwartzmeyer
2016-04-12 16:16:17 -07:00
parent 285253da02
commit 841f76ec37
3 changed files with 31 additions and 21 deletions
+29 -3
View File
@@ -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)
```
+1 -9
View File
@@ -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
======================
+1 -9
View File
@@ -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
======================