From 3cbe607d87c7eebf8f68389b695f43ac9e436ef7 Mon Sep 17 00:00:00 2001 From: Victor Vazquez Date: Thu, 12 Nov 2020 20:22:29 -0800 Subject: [PATCH] Update contributing guide for vcpkg steps (#977) --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c97e7d9fc..c5c4f2b92 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,7 +65,7 @@ Follow [vcpkg install guide](https://github.com/microsoft/vcpkg#getting-started) ./vcpkg install curl libxml2 ``` -When using vcpkg, make sure to set the `VCPKG_ROOT` environment variable to the vcpkg Git repository folder before using `CMake`. +When using vcpkg, you can set the `VCPKG_ROOT` environment variable to the vcpkg Git repository folder. This would automatically set the CMake variable `CMAKE_TOOLCHAIN_FILE` for you, enabling the project to use any library installed with vcpkg. The Azure SDK for C++ uses [this vcpkg release version](https://github.com/Azure/azure-sdk-for-cpp/blob/master/eng/vcpkg-commit.txt) for continuos integration (CI) building and testing. Make sure to checkout this version when following the next steps for building and running the Azure SDK for C++. Using a newer vcpkg version might still work, however, if it is tested. @@ -85,8 +85,7 @@ git checkout ### Building and Testing #### Building the project -First, ensure that the `VCPKG_ROOT` environment variable is set, as described [above](#vcpkg). This needs to be defined -any time you want to build using vcpkg. Then generate the build files and build as you would with any standard CMake project. From the +Generate the CMake files and build as you would with any standard CMake project. From the repo root, run: ```sh