Vcpkg: 总览

Vcpkg: 总览

English Overview

Vcpkg 可帮助您在 Windows、 Linux 和 MacOS 上管理 C 和 C++ 库。
这个工具和生态链正在不断发展，我们一直期待您的贡献！

若您从未使用过vcpkg或希望了解如何使用vcpkg，请查阅快速开始章节。

如需获取有关可用命令的简短描述，请在编译vcpkg后执行 vcpkg help 或执行 vcpkg help [command] 来获取具体的帮助信息。

• Github: https://github.com/microsoft/vcpkg
• Slack: https://cppalliance.org/slack/， #vcpkg 频道
• Discord: #include ， #vcpkg 频道
• 文档: Documentation

入门

首先，请阅读以下任一方面的快速入门指南：
Windows 或 macOS和Linux，
这取决于您使用的是什么平台。

有关更多信息，请参见 安装和使用软件包。
如果vcpkg目录中没有您需要的库，
您可以 在GitHub上打开问题。
vcpkg团队和贡献者可以看到它的地方，
并可能将这个库添加到vcpkg。

安装并运行vcpkg后，
您可能希望将 TAB补全 添加到您的Shell中。

最后，如果您对vcpkg的未来感兴趣，请查看 清单！
这是一项实验性功能，可能会出现错误。
因此，请尝试一下并打开所有问题!

快速开始: Windows

需求:

• Windows 7 或更新的版本
• Git
• Visual Studio 2015 Update 3 或更新的版本（包含英文语言包）

首先，请下载vcpkg并执行 bootstrap.bat 脚本。
它可以安装在任何地方，但是通常我们建议您使用 vcpkg 作为 CMake 项目的子模块，并将其全局安装到 Visual Studio 项目中。
我们建议您使用例如 C:\src\vcpkg 或 C:\dev\vcpkg 的安装目录，否则您可能遇到某些库构建系统的路径问题。

> git clone https://github.com/microsoft/vcpkg
> .\vcpkg\bootstrap-vcpkg.bat

使用以下命令安装您的项目所需要的库：

> .\vcpkg\vcpkg install [packages to install]

您也可以使用 search 子命令来查找vcpkg中集成的库:

> .\vcpkg\vcpkg search [search term]

若您希望在 Visual Studio 中使用vcpkg，请运行以下命令 (首次启动需要管理员权限)

> .\vcpkg\vcpkg integrate install

在此之后，您可以创建一个非cmake项目 (或打开已有的项目)。
在您的项目中，所有已安装的库均可立即使用 #include 包含您需使用的库的头文件并无需添加额外配置。

若您在 Visual Studio 中使用cmake工程，请查阅这里。

为了在IDE以外在cmake中使用vcpkg，您需要使用以下工具链文件:

> cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
> cmake --build [build directory]

在cmake中，您仍需通过 find_package 来使用第三方库。
请查阅 CMake 章节 获取更多信息，其中包含了在IDE中使用cmake的内容。

对于其他工具 (包括Visual Studio Code)，请查阅 集成指南。

快速开始: Unix

Linux平台的使用需求:

• Git
• g++ >= 6

macOS平台的使用需求:

• Apple Developer Tools
• macOS 10.14 或更低版本中，您也需要:
  • Homebrew
  • Homebrew 中 g++ >= 6

首先，请下载vcpkg并执行 bootstrap.sh 脚本。
我们建议您将vcpkg作为cmake项目的子模块使用。

$ git clone https://github.com/microsoft/vcpkg
$ ./vcpkg/bootstrap-vcpkg.sh

使用以下命令安装任意包：

$ ./vcpkg/vcpkg install [packages to install]

您也可以使用 search 子命令来查找vcpkg中已集成的库:

$ ./vcpkg/vcpkg search [search term]

为了在cmake中使用vcpkg，您需要使用以下工具链文件:

$ cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake
$ cmake --build [build directory]

在cmake中，您仍需通过 find_package 来使用第三方库。
为了您更好的在cmake或 VSCode CMake Tools 中使用vcpkg，
请查阅 CMake 章节 获取更多信息，
其中包含了在IDE中使用cmake的内容。

对于其他工具，请查阅 集成指南。

安装 Linux Developer Tools

在Linux的不同发行版中，您需要安装不同的工具包:

• Debian，Ubuntu，popOS或其他基于 Debian 的发行版:

$ sudo apt-get update
$ sudo apt-get install build-essential tar curl zip unzip

• CentOS

$ sudo yum install centos-release-scl
$ sudo yum install devtoolset-7
$ scl enable devtoolset-7 bash

对于其他的发行版，请确保已安装 g++ 6 或更新的版本。
若您希望添加特定发行版的说明，请提交一个 PR!

安装 macOS Developer Tools

在 macOS 10.15 中，唯一需要做的是在终端中运行以下命令:

$ xcode-select --install

然后按照出现的窗口中的提示进行操作。

在 macOS 10.14 及先前版本中，您也需要使用 homebrew 安装 g++。
请遵循以下部分中的说明：

在 macOS 10.15 之前版本中安装 GCC

此条只在您的macOS版本低于 10.15 时是必须的。
安装homebrew应当很轻松，请查阅 以获取更多信息。
为了更简便，请使用以下命令:

$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

然后，为了获取最新版本的gcc，请运行以下命令：

$ brew install gcc

此时，您就可以使用 bootstrap.sh 编译vcpkg了。 请参阅 快速开始

在 CMake 中使用 vcpkg

若您希望在CMake中使用vcpkg，以下内容可能帮助您：

Visual Studio Code 中的 CMake Tools

将以下内容添加到您的工作区的 settings.json 中将使CMake Tools自动使用vcpkg中的第三方库:

{
  "cmake.configureSettings": {
    "CMAKE_TOOLCHAIN_FILE": "[vcpkg root]/scripts/buildsystems/vcpkg.cmake"
  }
}

Visual Studio CMake 工程中使用 vcpkg

打开CMake设置选项，将 vcpkg toolchain 文件路径在 CMake toolchain file 中：

[vcpkg root]/scripts/buildsystems/vcpkg.cmake

CLion 中使用 vcpkg

打开 Toolchains 设置
(File > Settings on Windows and Linux, CLion > Preferences on macOS)，
并打开 CMake 设置 (Build, Execution, Deployment > CMake)。
最后在 CMake options 中添加以下行:

-DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake

遗憾的是，您必须手动将此选项加入每个项目配置文件中。

将 vcpkg 作为一个子模块

当您希望将vcpkg作为一个子模块加入到您的工程中时，
您可以在第一个 project() 调用之前将以下内容添加到 CMakeLists.txt 中，
而无需将 CMAKE_TOOLCHAIN_FILE 传递给cmake调用。

set(CMAKE_TOOLCHAIN_FILE ${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake
  CACHE STRING "Vcpkg toolchain file")

使用此种方式可无需设置 CMAKE_TOOLCHAIN_FILE 即可使用vcpkg，且更容易完成配置工作。

Tab补全/自动补全

vcpkg 支持命令，包名称，以及 Powershell 和 Bash 中的选项。
若您需要在指定的 shell 中启用Tab补全功能，请依据您使用的shell运行：

> .\vcpkg integrate powershell

或

$ ./vcpkg integrate bash

然后重新启动控制台。

示例

请查看 文档 获取具体示例，
其包含 安装并使用包，
使用压缩文件添加包
和 从GitHub源中添加一个包。

我们的文档现在也可以从 ReadTheDocs 在线获取。

观看4分钟 demo视频。

贡献者

Vcpkg是一个开源项目，并通过您的贡献不断发展。
下面是一些您可以贡献的方式:

• 提交一个关于vcpkg或已支持包的新issue
• 提交修复PR和创建新包

请参阅我们的 贡献准则 了解更多详细信息。

该项目采用了 Microsoft开源行为准则。
获取更多信息请查看 行为准则FAQ 或联系 [email protected]提出其他问题或意见。

License

在此存储库中使用的代码均遵循 MIT License。

数据收集

vcpkg会收集使用情况数据，以帮助我们改善您的体验。
Microsoft收集的数据是匿名的。
您也可以通过使用 -disableMetrics 、在命令行上将--disable-metrics传递给vcpkg，或通过设置环境变量 VCPKG_DISABLE_METRICS 并重新运行 bootstrap-vcpkg 脚本来选择禁用数据收集。
请在 privacy.md 中了解有关 vcpkg 数据收集的更多信息。