From 7b2d101668a3fd01d6c6c0a44d3b40af8f7a4498 Mon Sep 17 00:00:00 2001 From: Jianyun Tao Date: Wed, 20 Jul 2016 17:09:41 -0700 Subject: [PATCH 1/2] added "recursive cloning" back to readme per request #1197 --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b1e5f6d31..799431411f 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,16 @@ Building PowerShell |-----------------------|-------|-------------------|------| | Build from **Source** | [Instructions][build-linux] | [Instructions][build-wc] | [Instructions][build-osx] | +Downloading the Source Code +---------------------- +The PowerShell repository has a number of other repositories embedded as submodules. +To make things easy, we can just clone recursively. + +```sh +git clone --recursive https://github.com/PowerShell/PowerShell.git +``` +See [working with the PowerShell repository][powershell-repo-101] for more information. + Developing and Contributing -------------------------- @@ -46,7 +56,7 @@ If you encounter issues in your development, please consult the [known issues][k and [FAQ][faq] documents to see if the issue you are running into is captured and if a workaround exists. -If you encounter issues with PowerShell itself, first search for it in our [issues][github-issues]. +If you encounter issues with PowerShell itself, first search for it in our [issues][github-issues]. If you do not see your issue captured, please file a [new issue][new-issue]. For more details see [Contributing to issues][contribution-issues]. PowerShell Community @@ -63,7 +73,7 @@ Legal and Licensing Code of Conduct --------------- -This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code]. +This project has adopted the [Microsoft Open Source Code of Conduct][conduct-code]. For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [opencode@microsoft.com][conduct-email] with any additional questions or comments. @@ -85,3 +95,4 @@ For more information see the [Code of Conduct FAQ][conduct-FAQ] or contact [new-issue]:https://github.com/PowerShell/PowerShell/issues/new [pls-omi-provider]: https://github.com/PowerShell/psl-omi-provider [releases]: https://github.com/PowerShell/PowerShell/releases +[powershell-repo-101]: docs/git/powershell-repository-101.md From 31344808bde326abe1c6f7ea9a6f9f120b743e83 Mon Sep 17 00:00:00 2001 From: Jianyun Tao Date: Wed, 20 Jul 2016 17:23:06 -0700 Subject: [PATCH 2/2] Updated the Downloading Source code section to address the feedback from lzybkr. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 799431411f..1813aca073 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,12 @@ To make things easy, we can just clone recursively. ```sh git clone --recursive https://github.com/PowerShell/PowerShell.git ``` + +If you already cloned but forgot to use `--recursive`, you can update submodules manually: +```sh +git submodule init +git submodule update +``` See [working with the PowerShell repository][powershell-repo-101] for more information. Developing and Contributing