From 491d01935a2d9085907b78d1aa9a7a0786e62294 Mon Sep 17 00:00:00 2001 From: David Matson Date: Thu, 3 Aug 2023 10:28:10 -0700 Subject: [PATCH] Recommend self-contain repos/submodules regardless of build system. (#32698) Fixes #31466. --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a59eca8755..155d5a5335 100644 --- a/README.md +++ b/README.md @@ -62,11 +62,10 @@ Prerequisites: - [Git][getting-started:git] - [Visual Studio][getting-started:visual-studio] 2015 Update 3 or greater with the English language pack -First, download and bootstrap vcpkg itself; it can be installed anywhere, -but generally we recommend using vcpkg as a submodule for CMake projects, -and installing it globally for Visual Studio projects. -We recommend somewhere like `C:\src\vcpkg` or `C:\dev\vcpkg`, -since otherwise you may run into path issues for some port build systems. +First, download and bootstrap vcpkg itself; it can be installed anywhere, but generally we recommend using vcpkg as a +submodule so the consuming repo can stay self-contained. Alternatively, vcpkg can be installed globally; we recommend +somewhere like `C:\src\vcpkg` or `C:\dev\vcpkg`, since otherwise you may run into path issues for some port build +systems. ```cmd > git clone https://github.com/microsoft/vcpkg @@ -133,7 +132,7 @@ Prerequisites for macOS: - [Apple Developer Tools][getting-started:macos-dev-tools] First, download and bootstrap vcpkg itself; it can be installed anywhere, -but generally we recommend using vcpkg as a submodule for CMake projects. +but generally we recommend using vcpkg as a submodule. ```sh $ git clone https://github.com/microsoft/vcpkg @@ -237,7 +236,7 @@ Finally, in `CMake options`, add the following line: You must add this line to each profile. -### Vcpkg as a Submodule +### Vcpkg as a Submodule with CMake When using vcpkg as a submodule of your project, you can add the following to your CMakeLists.txt before the first `project()` call,