From 7a4ebdf73dbe2c5e030f0741111b98f2e96d168c Mon Sep 17 00:00:00 2001 From: Anton Kolesnyk <41349689+antkmsft@users.noreply.github.com> Date: Thu, 3 Jun 2021 17:59:09 +0000 Subject: [PATCH] Docs: link to root Getting Started section from Core's readme (#2386) * Docs: link to root Getting Started section from Core's readme * Update sdk/core/azure-core/README.md Co-authored-by: Anton Kolesnyk --- sdk/core/azure-core/README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/sdk/core/azure-core/README.md b/sdk/core/azure-core/README.md index bab12bc78..06bf4be7d 100644 --- a/sdk/core/azure-core/README.md +++ b/sdk/core/azure-core/README.md @@ -8,6 +8,23 @@ The library allows client libraries to expose common functionality in a consiste Typically, you will not need to download `azure-core`; it will be downloaded for you as a dependency of the client libraries. In case you want to download it explicitly (to implement your own client library, for example), you can find the source in here, or use vcpkg to install the package `azure-core-cpp`. +### Include the package + +The easiest way to acquire the C++ SDK is leveraging vcpkg package manager. See the corresponding [Azure SDK for C++ readme section][azsdk_vcpkg_install]. + +To install Azure Core package via vcpkg: + +```cmd +> vcpkg install azure-core-cpp +``` + +Then, use in your CMake file: + +```CMake +find_package(azure-core-cpp CONFIG REQUIRED) +target_link_libraries( PRIVATE Azure::azure-core) +``` + ## Key concepts The main shared concepts of `Azure::Core` include: @@ -100,7 +117,7 @@ Security issues and bugs should be reported privately, via email, to the Microso Azure SDK for C++ is licensed under the [MIT](https://github.com/Azure/azure-sdk-for-cpp/blob/master/sdk/core/azure-core/LICENSE) license. - +[azsdk_vcpkg_install]: https://github.com/Azure/azure-sdk-for-cpp#download--install-the-sdk [azure_sdk_for_cpp_contributing]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md [azure_sdk_for_cpp_contributing_developer_guide]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#developer-guide [azure_sdk_for_cpp_contributing_pull_requests]: https://github.com/Azure/azure-sdk-for-cpp/blob/master/CONTRIBUTING.md#pull-requests