mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-11-24 01:59:00 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Recommend self-contain repos/submodules regardless of build system. (#32698)

Browse Source 
Fixes #31466.
This commit is contained in:
David Matson 2023-08-03 10:28:10 -07:00 committed by GitHub
parent 06a42bb8ab
commit 491d01935a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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,