ceph/src/jaegertracing/opentelemetry-cpp/tools/vcpkg/README_zh_CN.md

   1 # Vcpkg: 总览
   2
   3 [English Overview](README.md)
   4
   5 Vcpkg 可帮助您在 Windows、 Linux 和 MacOS 上管理 C 和 C++ 库。
   6 这个工具和生态链正在不断发展，我们一直期待您的贡献！
   7
   8 若您从未使用过vcpkg或希望了解如何使用vcpkg，请查阅[快速开始](#入门)章节。
   9
  10 如需获取有关可用命令的简短描述，请在编译vcpkg后执行 `vcpkg help` 或执行 `vcpkg help [command]` 来获取具体的帮助信息。
  11
  12 * Github: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg)
  13 * Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/)， #vcpkg 频道
  14 * Discord: [\#include \<C++\>](https://www.includecpp.org)， #🌏vcpkg 频道
  15 * 文档: [Documentation](docs/README.md)
  16
  17 [![当前生成状态](https://dev.azure.com/vcpkg/public/_apis/build/status/microsoft.vcpkg.ci?branchName=master)](https://dev.azure.com/vcpkg/public/_build/latest?definitionId=29&branchName=master)
  18
  19 # 目录
  20
  21 - [Vcpkg: 总览](#vcpkg-总览)
  22 - [目录](#目录)
  23 - [入门](#入门)
  24   - [快速开始: Windows](#快速开始-windows)
  25   - [快速开始: Unix](#快速开始-unix)
  26   - [安装 Linux Developer Tools](#安装-linux-developer-tools)
  27   - [安装 macOS Developer Tools](#安装-macos-developer-tools)
  28     - [在 macOS 10.15 之前版本中安装 GCC](#在-macos-1015-之前版本中安装-gcc)
  29   - [在 CMake 中使用 vcpkg](#在-cmake-中使用-vcpkg)
  30     - [Visual Studio Code 中的 CMake Tools](#visual-studio-code-中的-cmake-tools)
  31     - [Visual Studio CMake 工程中使用 vcpkg](#visual-studio-cmake-工程中使用-vcpkg)
  32     - [CLion 中使用 vcpkg](#clion-中使用-vcpkg)
  33     - [将 vcpkg 作为一个子模块](#将-vcpkg-作为一个子模块)
  34 - [Tab补全/自动补全](#tab补全自动补全)
  35   - [示例](#示例)
  36   - [贡献者](#贡献者)
  37 - [License](#license)
  38 - [数据收集](#数据收集)
  39
  40 # 入门
  41
  42 首先，请阅读以下任一方面的快速入门指南：
  43 [Windows](#快速开始-windows) 或 [macOS和Linux](#快速开始-unix)，
  44 这取决于您使用的是什么平台。
  45
  46 有关更多信息，请参见 [安装和使用软件包][getting-started:using-a-package]。
  47 如果vcpkg目录中没有您需要的库，
  48 您可以 [在GitHub上打开问题][contributing:submit-issue]。
  49 vcpkg团队和贡献者可以看到它的地方，
  50 并可能将这个库添加到vcpkg。
  51
  52 安装并运行vcpkg后，
  53 您可能希望将 [TAB补全](#tab补全自动补全) 添加到您的Shell中。
  54
  55 最后，如果您对vcpkg的未来感兴趣，请查看 [清单][getting-started:manifest-spec]！
  56 这是一项实验性功能，可能会出现错误。
  57 因此，请尝试一下并[打开所有问题][contributing:submit-issue]!
  58
  59 ## 快速开始: Windows
  60
  61 需求:
  62 - Windows 7 或更新的版本
  63 - [Git][getting-started:git]
  64 - [Visual Studio 2015 Update 3][getting-started:visual-studio] 或更新的版本（包含英文语言包）
  65
  66 首先，请下载vcpkg并执行 bootstrap.bat 脚本。
  67 它可以安装在任何地方，但是通常我们建议您使用 vcpkg 作为 CMake 项目的子模块，并将其全局安装到 Visual Studio 项目中。
  68 我们建议您使用例如 `C:\src\vcpkg` 或 `C:\dev\vcpkg` 的安装目录，否则您可能遇到某些库构建系统的路径问题。
  69
  70 ```cmd
  71 > git clone https://github.com/microsoft/vcpkg
  72 > .\vcpkg\bootstrap-vcpkg.bat
  73 ```
  74
  75 使用以下命令安装您的项目所需要的库：
  76
  77 ```cmd
  78 > .\vcpkg\vcpkg install [packages to install]
  79 ```
  80
  81 您也可以使用 `search` 子命令来查找vcpkg中集成的库:
  82
  83 ```cmd
  84 > .\vcpkg\vcpkg search [search term]
  85 ```
  86
  87 若您希望在 Visual Studio 中使用vcpkg，请运行以下命令 (首次启动需要管理员权限)
  88
  89 ```cmd
  90 > .\vcpkg\vcpkg integrate install
  91 ```
  92
  93 在此之后，您可以创建一个非cmake项目 (或打开已有的项目)。
  94 在您的项目中，所有已安装的库均可立即使用 `#include` 包含您需使用的库的头文件并无需添加额外配置。
  95
  96 若您在 Visual Studio 中使用cmake工程，请查阅[这里](#visual-studio-cmake-工程中使用-vcpkg)。
  97
  98 为了在IDE以外在cmake中使用vcpkg，您需要使用以下工具链文件:
  99
 100 ```cmd
 101 > cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
 102 > cmake --build [build directory]
 103 ```
 104
 105 在cmake中，您仍需通过 `find_package` 来使用第三方库。
 106 请查阅 [CMake 章节](#在-cmake-中使用-vcpkg) 获取更多信息，其中包含了在IDE中使用cmake的内容。
 107
 108 对于其他工具 (包括Visual Studio Code)，请查阅 [集成指南][getting-started:integration]。
 109
 110 ## 快速开始: Unix
 111
 112 Linux平台的使用需求:
 113 - [Git][getting-started:git]
 114 - [g++][getting-started:linux-gcc] >= 6
 115
 116 macOS平台的使用需求:
 117 - [Apple Developer Tools][getting-started:macos-dev-tools]
 118 - macOS 10.14 或更低版本中，您也需要:
 119   - [Homebrew][getting-started:macos-brew]
 120   - Homebrew 中 [g++][getting-started:macos-gcc] >= 6
 121
 122 首先，请下载vcpkg并执行 bootstrap.sh 脚本。
 123 我们建议您将vcpkg作为cmake项目的子模块使用。
 124
 125 ```sh
 126 $ git clone https://github.com/microsoft/vcpkg
 127 $ ./vcpkg/bootstrap-vcpkg.sh
 128 ```
 129
 130 使用以下命令安装任意包：
 131
 132 ```sh
 133 $ ./vcpkg/vcpkg install [packages to install]
 134 ```
 135
 136 您也可以使用 `search` 子命令来查找vcpkg中已集成的库:
 137
 138 ```sh
 139 $ ./vcpkg/vcpkg search [search term]
 140 ```
 141
 142 为了在cmake中使用vcpkg，您需要使用以下工具链文件:
 143
 144 ```sh
 145 $ cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
 146 $ cmake --build [build directory]
 147 ```
 148
 149 在cmake中，您仍需通过 `find_package` 来使用第三方库。
 150 为了您更好的在cmake或 VSCode CMake Tools 中使用vcpkg，
 151 请查阅 [CMake 章节](#在-cmake-中使用-vcpkg) 获取更多信息，
 152 其中包含了在IDE中使用cmake的内容。
 153
 154 对于其他工具，请查阅 [集成指南][getting-started:integration]。
 155
 156 ## 安装 Linux Developer Tools
 157
 158 在Linux的不同发行版中，您需要安装不同的工具包:
 159
 160 - Debian，Ubuntu，popOS或其他基于 Debian 的发行版:
 161
 162 ```sh
 163 $ sudo apt-get update
 164 $ sudo apt-get install build-essential tar curl zip unzip
 165 ```
 166
 167 - CentOS
 168
 169 ```sh
 170 $ sudo yum install centos-release-scl
 171 $ sudo yum install devtoolset-7
 172 $ scl enable devtoolset-7 bash
 173 ```
 174
 175 对于其他的发行版，请确保已安装 g++ 6 或更新的版本。
 176 若您希望添加特定发行版的说明，[请提交一个 PR][contributing:submit-pr]!
 177
 178 ## 安装 macOS Developer Tools
 179
 180 在 macOS 10.15 中，唯一需要做的是在终端中运行以下命令:
 181
 182 ```sh
 183 $ xcode-select --install
 184 ```
 185
 186 然后按照出现的窗口中的提示进行操作。
 187
 188 在 macOS 10.14 及先前版本中，您也需要使用 homebrew 安装 g++。
 189 请遵循以下部分中的说明：
 190
 191 ### 在 macOS 10.15 之前版本中安装 GCC
 192
 193 此条只在您的macOS版本低于 10.15 时是必须的。
 194 安装homebrew应当很轻松，请查阅 <brew.sh> 以获取更多信息。
 195 为了更简便，请使用以下命令:
 196
 197 ```sh
 198 $ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
 199 ```
 200
 201 然后，为了获取最新版本的gcc，请运行以下命令：
 202
 203 ```sh
 204 $ brew install gcc
 205 ```
 206
 207 此时，您就可以使用 bootstrap.sh 编译vcpkg了。 请参阅 [快速开始](#快速开始-unix)
 208
 209 ## 在 CMake 中使用 vcpkg
 210
 211 若您希望在CMake中使用vcpkg，以下内容可能帮助您：
 212
 213 ### Visual Studio Code 中的 CMake Tools
 214
 215 将以下内容添加到您的工作区的 `settings.json` 中将使CMake Tools自动使用vcpkg中的第三方库:
 216
 217 ```json
 218 {
 219   "cmake.configureSettings": {
 220     "CMAKE_TOOLCHAIN_FILE": "[vcpkg root]/scripts/buildsystems/vcpkg.cmake"
 221   }
 222 }
 223 ```
 224
 225 ### Visual Studio CMake 工程中使用 vcpkg
 226
 227 打开CMake设置选项，将 vcpkg toolchain 文件路径在 `CMake toolchain file` 中：
 228
 229 ```
 230 [vcpkg root]/scripts/buildsystems/vcpkg.cmake
 231 ```
 232
 233 ### CLion 中使用 vcpkg
 234
 235 打开 Toolchains 设置
 236 (File > Settings on Windows and Linux, CLion > Preferences on macOS)，
 237 并打开 CMake 设置 (Build, Execution, Deployment > CMake)。
 238 最后在 `CMake options` 中添加以下行:
 239
 240 ```
 241 -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake
 242 ```
 243
 244 遗憾的是，您必须手动将此选项加入每个项目配置文件中。
 245
 246 ### 将 vcpkg 作为一个子模块
 247
 248 当您希望将vcpkg作为一个子模块加入到您的工程中时，
 249 您可以在第一个 `project()` 调用之前将以下内容添加到 CMakeLists.txt 中，
 250 而无需将 `CMAKE_TOOLCHAIN_FILE` 传递给cmake调用。
 251
 252 ```cmake
 253 set(CMAKE_TOOLCHAIN_FILE ${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake
 254   CACHE STRING "Vcpkg toolchain file")
 255 ```
 256
 257 使用此种方式可无需设置 `CMAKE_TOOLCHAIN_FILE` 即可使用vcpkg，且更容易完成配置工作。
 258
 259 [getting-started:using-a-package]: docs/examples/installing-and-using-packages.md
 260 [getting-started:integration]: docs/users/integration.md
 261 [getting-started:git]: https://git-scm.com/downloads
 262 [getting-started:cmake-tools]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools
 263 [getting-started:linux-gcc]: #installing-linux-developer-tools
 264 [getting-started:macos-dev-tools]: #installing-macos-developer-tools
 265 [getting-started:macos-brew]: #installing-gcc-on-macos
 266 [getting-started:macos-gcc]: #installing-gcc-on-macos
 267 [getting-started:visual-studio]: https://visualstudio.microsoft.com/
 268 [getting-started:manifest-spec]: docs/specifications/manifests.md
 269
 270 # Tab补全/自动补全
 271
 272 `vcpkg` 支持命令，包名称，以及 Powershell 和 Bash 中的选项。
 273 若您需要在指定的 shell 中启用Tab补全功能，请依据您使用的shell运行：
 274
 275 ```pwsh
 276 > .\vcpkg integrate powershell
 277 ```
 278
 279 或
 280
 281 ```sh
 282 $ ./vcpkg integrate bash
 283 ```
 284
 285 然后重新启动控制台。
 286
 287 ## 示例
 288
 289 请查看 [文档](docs/README.md) 获取具体示例，
 290 其包含 [安装并使用包](docs/examples/installing-and-using-packages.md)，
 291 [使用压缩文件添加包](docs/examples/packaging-zipfiles.md)
 292 和 [从GitHub源中添加一个包](docs/examples/packaging-github-repos.md)。
 293
 294 我们的文档现在也可以从 [ReadTheDocs](https://vcpkg.readthedocs.io/) 在线获取。
 295
 296 观看4分钟 [demo视频](https://www.youtube.com/watch?v=y41WFKbQFTw)。
 297
 298 ## 贡献者
 299
 300 Vcpkg是一个开源项目，并通过您的贡献不断发展。
 301 下面是一些您可以贡献的方式:
 302
 303 * [提交一个关于vcpkg或已支持包的新issue][contributing:submit-issue]
 304 * [提交修复PR和创建新包][contributing:submit-pr]
 305
 306 请参阅我们的 [贡献准则](CONTRIBUTING.md) 了解更多详细信息。
 307
 308 该项目采用了 [Microsoft开源行为准则][contributing:coc]。
 309 获取更多信息请查看 [行为准则FAQ][contributing:coc-faq] 或联系 [opencode@microsoft.com](mailto:opencode@microsoft.com)提出其他问题或意见。
 310
 311 [contributing:submit-issue]: https://github.com/microsoft/vcpkg/issues/new/choose
 312 [contributing:submit-pr]: https://github.com/microsoft/vcpkg/pulls
 313 [contributing:coc]: https://opensource.microsoft.com/codeofconduct/
 314 [contributing:coc-faq]: https://opensource.microsoft.com/codeofconduct/
 315
 316 # License
 317
 318 在此存储库中使用的代码均遵循 [MIT License](LICENSE.txt)。
 319
 320 # 数据收集
 321
 322 vcpkg会收集使用情况数据，以帮助我们改善您的体验。
 323 Microsoft收集的数据是匿名的。
 324 您也可以通过使用 `-disableMetrics` 、在命令行上将`--disable-metrics`传递给vcpkg，或通过设置环境变量 `VCPKG_DISABLE_METRICS` 并重新运行 bootstrap-vcpkg 脚本来选择禁用数据收集。
 325 请在 [privacy.md](docs/about/privacy.md) 中了解有关 vcpkg 数据收集的更多信息。