Vcpkg 可帮助您在 Windows、 Linux 和 MacOS 上管理 C 和 C++ 库

# Vcpkg: Overview [涓枃鎬昏](README_zh_CN.md) [Espa帽ol](README_es.md) [頃滉淡鞏碷(README_ko_KR.md) [Fran莽ais](README_fr.md) Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This tool and ecosystem are constantly evolving, and we always appreciate contributions! If you've never used vcpkg before, or if you're trying to figure out how to use vcpkg, check out our [Getting Started](#getting-started) section for how to start using vcpkg. For short description of available commands, once you've installed vcpkg, you can run `vcpkg help`, or `vcpkg help [command]` for command-specific help. * Github: ports at [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg), program at [https://github.com/microsoft/vcpkg-tool](https://github.com/microsoft/vcpkg-tool) * Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/), the #vcpkg channel * Discord: [\#include \<C++\>](https://www.includecpp.org), the #馃審vcpkg channel * Docs: [Documentation](docs/README.md) # Table of Contents - [Vcpkg: Overview](#vcpkg-overview) - [Table of Contents](#table-of-contents) - [Getting Started](#getting-started) - [Quick Start: Windows](#quick-start-windows) - [Quick Start: Unix](#quick-start-unix) - [Installing Linux Developer Tools](#installing-linux-developer-tools) - [Installing macOS Developer Tools](#installing-macos-developer-tools) - [Using vcpkg with CMake](#using-vcpkg-with-cmake) - [Visual Studio Code with CMake Tools](#visual-studio-code-with-cmake-tools) - [Vcpkg with Visual Studio CMake Projects](#vcpkg-with-visual-studio-cmake-projects) - [Vcpkg with CLion](#vcpkg-with-clion) - [Vcpkg as a Submodule](#vcpkg-as-a-submodule) - [Tab-Completion/Auto-Completion](#tab-completionauto-completion) - [Examples](#examples) - [Contributing](#contributing) - [License](#license) - [Security](#security) - [Telemetry](#telemetry) # Getting Started First, follow the quick start guide for either [Windows](#quick-start-windows), or [macOS and Linux](#quick-start-unix), depending on what you're using. For more information, see [Installing and Using Packages][getting-started:using-a-package]. If a library you need is not present in the vcpkg catalog, you can [open an issue on the GitHub repo][contributing:submit-issue] where the vcpkg team and community can see it, and potentially add the port to vcpkg. After you've gotten vcpkg installed and working, you may wish to add [tab completion](#tab-completionauto-completion) to your shell. Finally, if you're interested in the future of vcpkg, check out the [manifest][getting-started:manifest-spec] guide! This is an experimental feature and will likely have bugs, so try it out and [open all the issues][contributing:submit-issue]! ## Quick Start: Windows Prerequisites: - Windows 7 or newer - [Git][getting-started:git] - [Visual Studio][getting-started:visual-studio] 2015 Update 3 or greater with the English language pack First, download and bootstrap vcpkg itself; it can be installed anywhere, but generally we recommend using vcpkg as a submodule for CMake projects, and installing it globally for Visual Studio projects. We recommend somewhere like `C:\src\vcpkg` or `C:\dev\vcpkg`, since otherwise you may run into path issues for some port build systems. ```cmd > git clone https://github.com/microsoft/vcpkg > .\vcpkg\bootstrap-vcpkg.bat ``` To install the libraries for your project, run: ```cmd > .\vcpkg\vcpkg install [packages to install] ``` Note: This will install x86 libraries by default. To install x64, run: ```cmd > .\vcpkg\vcpkg install [package name]:x64-windows ``` Or ```cmd > .\vcpkg\vcpkg install [packages to install] --triplet=x64-windows ``` You can also search for the libraries you need with the `search` subcommand: ```cmd > .\vcpkg\vcpkg search [search term] ``` In order to use vcpkg with Visual Studio, run the following command (may require administrator elevation): ```cmd > .\vcpkg\vcpkg integrate install ``` After this, you can now create a New non-CMake Project (or open an existing one). All installed libraries are immediately ready to be `#include`'d and used in your project without additional configuration. If you're using CMake with Visual Studio, continue [here](#vcpkg-with-visual-studio-cmake-projects). In order to use vcpkg with CMake outside of an IDE, you can use the toolchain file: ```cmd > cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake > cmake --build [build directory] ``` With CMake, you will still need to `find_package` and the like to use the libraries. Check out the [CMake section](#using-vcpkg-with-cmake) for more information, including on using CMake with an IDE. For any other tools, including Visual Studio Code, check out the [integration guide][getting-started:integration]. ## Quick Start: Unix Prerequisites for Linux: - [Git][getting-started:git] - [g++][getting-started:linux-gcc] >= 6 Prerequisites for macOS: - [Apple Developer Tools][getting-started:macos-dev-tools] First, download and bootstrap vcpkg itself; it can be installed anywhere, but generally we recommend using vcpkg as a submodule for CMake projects. ```sh $ git clone https://github.com/microsoft/vcpkg $ ./vcpkg/bootstrap-vcpkg.sh ``` To install the libraries for your project, run: ```sh $ ./vcpkg/vcpkg install [packages to install] ``` You can also search for the libraries you need with the `search` subcommand: ```sh $ ./vcpkg/vcpkg search [search term] ``` In order to use vcpkg with CMake, you can use the toolchain file: ```sh $ cmake -B [build directory] -S . -DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake $ cmake --build [build directory] ``` With CMake, you will still need to `find_package` and the like to use the libraries. Check out the [CMake section](#using-vcpkg-with-cmake) for more information on how best to use vcpkg with CMake, and CMake Tools for VSCode. For any other tools, check out the [integration guide][getting-started:integration]. ## Installing Linux Developer Tools Across the different distros of Linux, there are different packages you'll need to install: - Debian, Ubuntu, popOS, and other Debian-based distributions: ```sh $ sudo apt-get update $ sudo apt-get install build-essential tar curl zip unzip ``` - CentOS ```sh $ sudo yum install centos-release-scl $ sudo yum install devtoolset-7 $ scl enable devtoolset-7 bash ``` For any other distributions, make sure you're installing g++ 6 or above. If you want to add instructions for your specific distro, [please open a PR][contributing:submit-pr]! ## Installing macOS Developer Tools On macOS, the only thing you should need to do is run the following in your terminal: ```sh $ xcode-select --install ``` Then follow along with the prompts in the windows that comes up. You'll then be able to bootstrap vcpkg along with the [quick start guide](#quick-start-unix) ## Using vcpkg with CMake If you're using vcpkg with CMake, the following may help! ### Visual Studio Code with CMake Tools Adding the following to your workspace `settings.json` will make CMake Tools automatically use vcpkg for libraries: ```json { "cmake.configureSettings": { "CMAKE_TOOLCHAIN_FILE": "[vcpkg root]/scripts/buildsystems/vcpkg.cmake" } } ``` ### Vcpkg with Visual Studio CMake Projects Open the CMake Settings Editor, and under `CMake toolchain file`, add the path to the vcpkg toolchain file: ``` [vcpkg root]/scripts/buildsystems/vcpkg.cmake ``` ### Vcpkg with CLion Open the Toolchains settings (File > Settings on Windows and Linux, CLion > Preferences on macOS), and go to the CMake settings (Build, Execution, Deployment > CMake). Finally, in `CMake options`, add the following line: ``` -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake ``` Unfortunately, you'll have to add this to each profile. ### Vcpkg as a Submodule When using vcpkg as a submodule