aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBrad Anderson <eco@gnuk.net>2017-04-27 15:43:46 -0600
committerBrad Anderson <eco@gnuk.net>2017-04-27 15:43:46 -0600
commit369c60c0f95c351b3be61c16fe9ff6c6fbc807af (patch)
treebc0317edc35e7c96df7b3f1b6ab96d92c6450522 /docs
parent2e6d5c3611781c28b0efa62a6ea5bce17cf06d10 (diff)
downloadvcpkg-369c60c0f95c351b3be61c16fe9ff6c6fbc807af.tar.gz
vcpkg-369c60c0f95c351b3be61c16fe9ff6c6fbc807af.zip
VS2017 Open Folder CMAKE_TOOLCHAIN_FILE example
Diffstat (limited to 'docs')
-rw-r--r--docs/EXAMPLES.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/docs/EXAMPLES.md b/docs/EXAMPLES.md
index 7331bd81c..2463d321f 100644
--- a/docs/EXAMPLES.md
+++ b/docs/EXAMPLES.md
@@ -101,7 +101,31 @@ To remove the integration for your user, you can use `.\vcpkg integrate remove`.
The best way to use installed libraries with cmake is via the toolchain file `scripts\buildsystems\vcpkg.cmake`. To use this file, you simply need to add it onto your CMake command line as `-DCMAKE_TOOLCHAIN_FILE=D:\src\vcpkg\scripts\buildsystems\vcpkg.cmake`.
-Let's first make a simple CMake project with a main file.
+Alternatively, if you are using CMake through Open Folder with Visual Studio 2017 you can define `CMAKE_TOOLCHAIN_FILE` by adding a `variables` section to your `CMakeSettings.json` configurations:
+
+```json
+{
+ "configurations": [
+ {
+ "name": "x86-Debug",
+ "generator": "Visual Studio 15 2017",
+ "configurationType" : "Debug",
+ "buildRoot": "${env.LOCALAPPDATA}\\CMakeBuild\\${workspaceHash}\\build\\${name}",
+ "cmakeCommandArgs": "",
+ "buildCommandArgs": "-m -v:minimal"
+ "variables": [
+ {
+ "name": "CMAKE_TOOLCHAIN_FILE",
+ "value": "D:\\src\\vcpkg\\scripts\\buildsystems\\vcpkg.cmake"
+ }
+ ]
+ },
+ // also add it to the other configurations...
+ ]
+}
+```
+
+Now let's make a simple CMake project with a main file.
```cmake
# CMakeLists.txt
cmake_minimum_required(VERSION 3.0)