Skip to content

Add recurse_submodules to git clone #648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bhardwajs wants to merge 1 commit into from
Closed

Add recurse_submodules to git clone #648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ acquire this dependency.
6. Run `.\vcpkg.exe integrate install` which tells Visual Studio which vcpkg instance you wish to use. If you have never
done this before, you may be prompted to elevate.
7. Open Visual Studio, and choose the "Clone or check out code" option. Enter the URL to this
repository, typically `https://github.com/microsoft/STL`
repository, typically `https://github.com/microsoft/STL`. Make sure that submodules are also checked out.
Copy link
Member

@BillyONeal BillyONeal Mar 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a checkbox or something for this? If not we need an extra step that explains how to do that.

8. Choose the architecture you wish to build in the IDE, and build as you would any other project. All necessary CMake
settings are set by `CMakeSettings.json` and `vcpkg integrate`

Expand All @@ -166,7 +166,7 @@ architectures.
5. Invoke `.\vcpkg.exe install boost-math:x64-windows` to install the boost-math dependency.
6. Open an "x64 Native Tools Command Prompt for VS 2019".
7. Change directories to a location where you'd like a clone of this STL repository.
8. Invoke `git clone https://github.com/microsoft/STL`
8. Invoke `git clone --recurse-submodules https://github.com/microsoft/STL`
Copy link
Member

@BillyONeal BillyONeal Mar 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should have only the instructions for the submodule necessary to build since bringing in this vcpkg copy might not be relevant for folks with an ambient vcpkg available

9. Invoke `cd STL`
10. Invoke `cmake -G Ninja -DCMAKE_TOOLCHAIN_FILE={where your vcpkg clone is located}\scripts\buildsystems\vcpkg.cmake
-S . -B {wherever you want binaries}` to configure the project. For example,
Expand Down