mirror of
https://github.com/microsoft/vcpkg.git
synced 2024-11-27 22:51:37 +08:00
Sync README with documentation website (#39655)
This commit is contained in:
Victor Romero
GitHub
parent
c202ce4d46
commit
b18ddfc9b5
387
README.md
387
README.md
@ -1,329 +1,146 @@
|
||||
# Vcpkg: Overview
|
||||
<!--
|
||||
This document is a copy of the README file on the Microsoft/vcpkg-docs repository.
|
||||
|
||||
[中文总览](README_zh_CN.md)
|
||||
[Español](README_es.md)
|
||||
[한국어](README_ko_KR.md)
|
||||
[Français](README_fr.md)
|
||||
[Tiếng Việt](README_vn.md)
|
||||
To make changes modify this file instead:
|
||||
https://github.com/microsoft/vcpkg-docs/blob/main/vcpkg/readme/vcpkg-README.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!
|
||||
[🌐 Read in a different language](https://learn.microsoft.com/locale/?target=https%3A%2F%2Flearn.microsoft.com%2Fvcpkg%2F)
|
||||
|
||||
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.
|
||||
# vcpkg overview
|
||||
|
||||
For short description of available commands, once you've installed vcpkg,
|
||||
you can run `vcpkg help`, or `vcpkg help [command]` for command-specific help.
|
||||
vcpkg is a free and open-source C/C++ package manager maintained by Microsoft
|
||||
and the C++ community.
|
||||
|
||||
* 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](https://learn.microsoft.com/vcpkg)
|
||||
Initially launched in 2016 as a tool for assisting developers in migrating their
|
||||
projects to newer versions of Visual Studio, vcpkg has evolved into a
|
||||
cross-platform tool used by developers on Windows, macOS, and Linux. vcpkg has a
|
||||
large collection of open-source libraries and enterprise-ready features designed to
|
||||
facilitate your development process with support for any build and project
|
||||
systems. vcpkg is a C++ tool at heart and is written in C++ with scripts in
|
||||
CMake. It is designed from the ground up to address the unique pain points C/C++
|
||||
developers experience.
|
||||
|
||||
# Table of Contents
|
||||
This tool and ecosystem are constantly evolving, and we always appreciate
|
||||
contributions! Learn how to start contributing with our [packaging
|
||||
tutorial](https://learn.microsoft.com/vcpkg/get_started/get-started-adding-to-registry) and [maintainer
|
||||
guide](https://learn.microsoft.com/vcpkg/contributing/maintainer-guide).
|
||||
|
||||
- [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-with-cmake)
|
||||
- [Tab-Completion/Auto-Completion](#tab-completionauto-completion)
|
||||
- [Examples](#examples)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Security](#security)
|
||||
- [Telemetry](#telemetry)
|
||||
# Get started
|
||||
|
||||
# Getting Started
|
||||
First, follow one of our quick start guides.
|
||||
|
||||
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.
|
||||
Whether you're using CMake, MSBuild, or any other build system, vcpkg has you covered:
|
||||
|
||||
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.
|
||||
* [vcpkg with CMake](https://learn.microsoft.com/vcpkg/get_started/get-started)
|
||||
* [vcpkg with MSBuild](https://learn.microsoft.com/vcpkg/get_started/get-started-msbuild)
|
||||
* [vcpkg with other build systems](https://learn.microsoft.com/vcpkg/users/buildsystems/manual-integration)
|
||||
|
||||
After you've gotten vcpkg installed and working,
|
||||
you may wish to add [tab completion](#tab-completionauto-completion) to your shell.
|
||||
You can also use any editor:
|
||||
|
||||
## Quick Start: Windows
|
||||
* [vcpkg with Visual Studio](https://learn.microsoft.com/vcpkg/get_started/get-started-vs)
|
||||
* [vcpkg with Visual Sudio Code](https://learn.microsoft.com/vcpkg/get_started/get-started-vscode)
|
||||
* [vcpkg with
|
||||
CLion](<https://www.jetbrains.com/help/clion/package-management.html>)
|
||||
|
||||
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
|
||||
If a library you need is not present in the vcpkg registry, [open an issue on
|
||||
the GitHub repository][contributing:submit-issue] or [contribute the package
|
||||
yourself](https://learn.microsoft.com/vcpkg/get_started/get-started-adding-to-registry).
|
||||
|
||||
First, download and bootstrap vcpkg itself; it can be installed anywhere, but generally we recommend using vcpkg as a
|
||||
submodule so the consuming repo can stay self-contained. Alternatively, vcpkg can be installed globally; we recommend
|
||||
somewhere like `C:\src\vcpkg` or `C:\dev\vcpkg`, since otherwise you may run into path issues for some port build
|
||||
systems.
|
||||
After you've gotten vcpkg installed and working, you may wish to [add
|
||||
tab completion to your terminal](https://learn.microsoft.com/vcpkg/commands/integrate#vcpkg-autocompletion).
|
||||
|
||||
```cmd
|
||||
> git clone https://github.com/microsoft/vcpkg
|
||||
> .\vcpkg\bootstrap-vcpkg.bat
|
||||
# Use vcpkg
|
||||
|
||||
Create a [manifest for your project's dependencies](https://learn.microsoft.com/vcpkg/consume/manifest-mode):
|
||||
|
||||
```Console
|
||||
vcpkg new --application
|
||||
vcpkg add port fmt
|
||||
```
|
||||
|
||||
To install the libraries for your project, run:
|
||||
Or [install packages through the command line](https://learn.microsoft.com/vcpkg/consume/classic-mode):
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [packages to install]
|
||||
```Console
|
||||
vcpkg install fmt
|
||||
```
|
||||
|
||||
Note: This will install x86 libraries by default. To install x64, run:
|
||||
Then use one of our available integrations for
|
||||
[CMake](https://learn.microsoft.com/vcpkg/concepts/build-system-integration#cmake-integration),
|
||||
[MSBuild](https://learn.microsoft.com/vcpkg/concepts/build-system-integration#msbuild-integration) or
|
||||
[other build
|
||||
systems](https://learn.microsoft.com/vcpkg/concepts/build-system-integration#manual-integration).
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [package name]:x64-windows
|
||||
```
|
||||
For a short description of all available commands, run `vcpkg help`.
|
||||
Run `vcpkg help [topic]` for details on a specific topic.
|
||||
|
||||
Or
|
||||
# Key features
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [packages to install] --triplet=x64-windows
|
||||
```
|
||||
vcpkg offers powerful features for your package management needs:
|
||||
|
||||
You can also search for the libraries you need with the `search` subcommand:
|
||||
* [easily integrate with your build system](https://learn.microsoft.com/vcpkg/concepts/build-system-integration)
|
||||
* [control the versions of your dependencies](https://learn.microsoft.com/vcpkg/users/versioning)
|
||||
* [package and publish your own packages](https://learn.microsoft.com/vcpkg/concepts/registries)
|
||||
* [reuse your binary artifacts](https://learn.microsoft.com/vcpkg/users/binarycaching)
|
||||
* [enable offline scenarios with asset caching](https://learn.microsoft.com/vcpkg/concepts/asset-caching)
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg search [search term]
|
||||
```
|
||||
# Contribute
|
||||
|
||||
In order to use vcpkg with Visual Studio,
|
||||
run the following command (may require administrator elevation):
|
||||
vcpkg is an open source project, and is thus built with your contributions. Here
|
||||
are some ways you can contribute:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg integrate install
|
||||
```
|
||||
* [Submit issues][contributing:submit-issue] in vcpkg or existing packages
|
||||
* [Submit fixes and new packages][contributing:submit-pr]
|
||||
|
||||
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.
|
||||
|
||||
## 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.
|
||||
|
||||
```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.
|
||||
|
||||
## 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
|
||||
|
||||
### 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
|
||||
|
||||
Vcpkg is integrated in the CLion IDE.
|
||||
For details, see the [official documentation](https://www.jetbrains.com/help/clion/package-management.html).
|
||||
|
||||
### Vcpkg as a Submodule with CMake
|
||||
|
||||
When using vcpkg as a submodule of your project,
|
||||
you can add the following to your CMakeLists.txt before the first `project()` call,
|
||||
instead of passing `CMAKE_TOOLCHAIN_FILE` to the cmake invocation.
|
||||
|
||||
```cmake
|
||||
set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "Vcpkg toolchain file")
|
||||
```
|
||||
|
||||
This will still allow people to not use vcpkg,
|
||||
by passing the `CMAKE_TOOLCHAIN_FILE` directly,
|
||||
but it will make the configure-build step slightly easier.
|
||||
|
||||
[getting-started:using-a-package]: https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages
|
||||
[getting-started:git]: https://git-scm.com/downloads
|
||||
[getting-started:cmake-tools]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools
|
||||
[getting-started:linux-gcc]: #installing-linux-developer-tools
|
||||
[getting-started:macos-dev-tools]: #installing-macos-developer-tools
|
||||
[getting-started:macos-brew]: #installing-gcc-on-macos
|
||||
[getting-started:macos-gcc]: #installing-gcc-on-macos
|
||||
[getting-started:visual-studio]: https://visualstudio.microsoft.com/
|
||||
|
||||
# Tab-Completion/Auto-Completion
|
||||
|
||||
`vcpkg` supports auto-completion of commands, package names,
|
||||
and options in both powershell and bash.
|
||||
To enable tab-completion in the shell of your choice, run:
|
||||
|
||||
```pwsh
|
||||
> .\vcpkg integrate powershell
|
||||
```
|
||||
|
||||
or
|
||||
|
||||
```sh
|
||||
$ ./vcpkg integrate bash # or zsh
|
||||
```
|
||||
|
||||
depending on the shell you use, then restart your console.
|
||||
|
||||
# Examples
|
||||
|
||||
See the [documentation](https://learn.microsoft.com/vcpkg) for specific walkthroughs,
|
||||
including [installing and using a package](https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages),
|
||||
[adding a new package from a zipfile](https://learn.microsoft.com/vcpkg/examples/packaging-zipfiles),
|
||||
and [adding a new package from a GitHub repo](https://learn.microsoft.com/vcpkg/examples/packaging-github-repos).
|
||||
|
||||
Our docs are now also available online at our website https://vcpkg.io/. We really appreciate any and all feedback! You can submit an issue in https://github.com/vcpkg/vcpkg.github.io/issues.
|
||||
|
||||
See a 4 minute [video demo](https://www.youtube.com/watch?v=y41WFKbQFTw).
|
||||
|
||||
# Contributing
|
||||
|
||||
Vcpkg is an open source project, and is thus built with your contributions.
|
||||
Here are some ways you can contribute:
|
||||
|
||||
* [Submit Issues][contributing:submit-issue] in vcpkg or existing packages
|
||||
* [Submit Fixes and New Packages][contributing:submit-pr]
|
||||
|
||||
Please refer to our [Contributing Guide](CONTRIBUTING.md) for more details.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct][contributing:coc].
|
||||
For more information see the [Code of Conduct FAQ][contributing:coc-faq]
|
||||
or email [opencode@microsoft.com](mailto:opencode@microsoft.com)
|
||||
with any additional questions or comments.
|
||||
Please refer to our [mantainer guide](https://learn.microsoft.com/vcpkg/contributing/maintainer-guide) and
|
||||
[packaging tutorial](https://learn.microsoft.com/vcpkg/get_started/get-started-packaging) for more details.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of
|
||||
Conduct][contributing:coc]. For more information see the [Code of Conduct
|
||||
FAQ][contributing:coc-faq] or email
|
||||
[opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional
|
||||
questions or comments.
|
||||
|
||||
[contributing:submit-issue]: https://github.com/microsoft/vcpkg/issues/new/choose
|
||||
[contributing:submit-pr]: https://github.com/microsoft/vcpkg/pulls
|
||||
[contributing:coc]: https://opensource.microsoft.com/codeofconduct/
|
||||
[contributing:coc-faq]: https://opensource.microsoft.com/codeofconduct/
|
||||
|
||||
# Resources
|
||||
|
||||
* Ports: [Microsoft/vcpkg](<https://github.com/microsoft/vcpkg>)
|
||||
* Source code: [Microsoft/vcpkg-tool](<https://github.com/microsoft/vcpkg-tool>)
|
||||
* Docs: [Microsoft Learn | vcpkg](https://learn.microsoft.com/vcpkg)
|
||||
* Website: [vcpkg.io](<https://vcpkg.io>)
|
||||
* Email: [vcpkg@microsoft.com](<mailto:vcpkg@microsoft.com>)
|
||||
* Discord: [\#include \<C++\>'s Discord server](<https://www.includecpp.org>), in the #🌏vcpkg channel
|
||||
* Slack: [C++ Alliance's Slack server](<https://cppalliance.org/slack/>), in the #vcpkg channel
|
||||
|
||||
# License
|
||||
|
||||
The code in this repository is licensed under the [MIT License](LICENSE.txt). The libraries
|
||||
provided by ports are licensed under the terms of their original authors. Where available, vcpkg
|
||||
places the associated license(s) in the location `installed/<triplet>/share/<port>/copyright`.
|
||||
The code in this repository is licensed under the MIT License. The libraries
|
||||
provided by ports are licensed under the terms of their original authors. Where
|
||||
available, vcpkg places the associated license(s) in the location
|
||||
[`installed/<triplet>/share/<port>/copyright`](https://learn.microsoft.com/vcpkg/contributing/maintainer-guide#install-copyright-file).
|
||||
|
||||
# Security
|
||||
|
||||
Most ports in vcpkg build the libraries in question using the original build system preferred
|
||||
by the original developers of those libraries, and download source code and build tools from their
|
||||
official distribution locations. For use behind a firewall, the specific access needed will depend
|
||||
on which ports are being installed. If you must install it in an "air gapped" environment, consider
|
||||
installing once in a non-"air gapped" environment, populating an
|
||||
[asset cache](https://learn.microsoft.com/vcpkg/users/assetcaching) shared with the otherwise "air gapped" environment.
|
||||
Most ports in vcpkg build the libraries in question using the original build
|
||||
system preferred by the original developers of those libraries, and download
|
||||
source code and build tools from their official distribution locations. For use
|
||||
behind a firewall, the specific access needed will depend on which ports are
|
||||
being installed. If you must install it in an "air gapped" environment, consider
|
||||
instaling once in a non-"air gapped" environment, populating an [asset
|
||||
cache](https://learn.microsoft.com/vcpkg/users/assetcaching) shared with the otherwise "air gapped"
|
||||
environment.
|
||||
|
||||
# Telemetry
|
||||
|
||||
vcpkg collects usage data in order to help us improve your experience.
|
||||
The data collected by Microsoft is anonymous.
|
||||
You can opt-out of telemetry by
|
||||
- running the bootstrap-vcpkg script with -disableMetrics
|
||||
- passing --disable-metrics to vcpkg on the command line
|
||||
- setting the VCPKG_DISABLE_METRICS environment variable
|
||||
vcpkg collects usage data in order to help us improve your experience. The data
|
||||
collected by Microsoft is anonymous. You can opt-out of telemetry by:
|
||||
|
||||
- running the bootstrap-vcpkg script with `-disableMetrics`
|
||||
- passing `--disable-metrics` to vcpkg on the command line
|
||||
- setting the `VCPKG_DISABLE_METRICS` environment variable
|
||||
|
||||
Read more about vcpkg telemetry at [https://learn.microsoft.com/vcpkg/about/privacy](https://learn.microsoft.com/vcpkg/about/privacy).
|
||||
|
||||
402
README_es.md
402
README_es.md
@ -1,402 +0,0 @@
|
||||
# Vcpkg
|
||||
|
||||
[中文总览](README_zh_CN.md)
|
||||
[English](README.md)
|
||||
[한국어](README_ko_KR.md)
|
||||
[Français](README_fr.md)
|
||||
|
||||
Vcpkg ayuda a manejar bibliotecas de C y C++ en Windows, Linux y MacOS.
|
||||
Esta herramienta y ecosistema se encuentran en constante evolución ¡Siempre apreciamos contribuciones nuevas!
|
||||
|
||||
Si nunca ha usado Vcpkg antes,
|
||||
o si está intentando aprender a usar vcpkg, consulte nuestra sección
|
||||
[Primeros pasos](#primeros-pasos) para iniciar a usar Vcpkg.
|
||||
|
||||
Para una descripción corta de los comandos disponibles,
|
||||
una vez instalado Vcpkg puede ejecutar `vcpkg help`, o
|
||||
`vcpkg help [comando]` para obtener ayuda específica de un comando.
|
||||
|
||||
* ports en: [vcpkg GitHub](https://github.com/microsoft/vcpkg)
|
||||
* este programa en: [vcpkg-tool GitHub](https://github.com/microsoft/vcpkg-tool)
|
||||
* [Slack](https://cppalliance.org/slack/), en el canal #vcpkg
|
||||
* Discord: [\#include \<C++\>](https://www.includecpp.org), en el canal #🌏vcpkg
|
||||
* Docs: [Documentación](https://learn.microsoft.com/vcpkg)
|
||||
|
||||
## Tabla de contenido
|
||||
|
||||
- [Vcpkg](#vcpkg)
|
||||
- [Tabla de contenido](#tabla-de-contenido)
|
||||
- [Primeros pasos](#primeros-pasos)
|
||||
- [Inicio Rápido: Windows](#inicio-rápido-windows)
|
||||
- [Inicio rápido: Unix](#inicio-rápido-unix)
|
||||
- [Instalando Herramientas de desarrollo en Linux](#instalando-herramientas-de-desarrollo-en-linux)
|
||||
- [Instalando Herramientas de desarrollo en macOS](#instalando-herramientas-de-desarrollo-en-macos)
|
||||
- [Usando Vcpkg con CMake](#usando-vcpkg-con-cmake)
|
||||
- [Visual Studio Code con CMake Tools](#visual-studio-code-con-cmake-tools)
|
||||
- [Vcpkg con proyectos de Visual Studio(CMake)](#vcpkg-con-proyectos-de-visual-studiocmake)
|
||||
- [Vcpkg con CLion](#vcpkg-con-clion)
|
||||
- [Vcpkg como Submódulo](#vcpkg-como-submódulo)
|
||||
- [Inicio rápido: Manifiestos](#inicio-rápido-manifiestos)
|
||||
- [Completado-Tab/Autocompletado](#completado-tabautocompletado)
|
||||
- [Ejemplos](#ejemplos)
|
||||
- [Contribuyendo](#contribuyendo)
|
||||
- [Licencia](#licencia)
|
||||
- [Seguridad](#seguridad)
|
||||
- [Telemetría](#telemetría)
|
||||
|
||||
## Primeros pasos
|
||||
|
||||
Antes de iniciar, siga la guía ya sea para [Windows](#inicio-rápido-windows),
|
||||
o [macOS y Linux](#inicio-rápido-unix) dependiendo del SO que use.
|
||||
|
||||
Para más información, ver [Instalando y Usando Paquetes][getting-started:using-a-package].
|
||||
Si una biblioteca que necesita no está presente en el catálogo de vcpkg,
|
||||
puede [abrir una incidencia en el repositorio de GitHub][contributing:submit-issue]
|
||||
donde el equipo de vcpkg y la comunidad pueden verlo, y potencialmente hacer un port a vcpkg.
|
||||
|
||||
Después de tener Vcpkg instalado y funcionando,
|
||||
puede que desee añadir [completado con tab](#Completado-TabAutoCompletado) en su terminal.
|
||||
|
||||
Finalmente, si está interesado en el futuro de Vcpkg,
|
||||
puede ver la guía de [archivos de manifiesto][getting-started:manifest-spec]!
|
||||
esta es una característica experimental y es probable que tenga errores,
|
||||
así que se recomienda revisar y [crear incidencias][contributing:submit-issue]!
|
||||
|
||||
### Inicio Rápido: Windows
|
||||
|
||||
Prerrequisitos:
|
||||
|
||||
- Windows 7 o superior
|
||||
- [Git][getting-started:git]
|
||||
- [Visual Studio][getting-started:visual-studio] 2015 Update 3 o superior con el paquete Inglés de Visual Studio.
|
||||
|
||||
Primero, descargue y compile vcpkg; puede ser instalado en cualquier lugar, pero por lo general recomendamos usar vcpkg
|
||||
como submódulo, asi el repositorio que lo consume puede permanecer autónomo.
|
||||
Alternativamente vcpkg puede ser instalado globalmente;
|
||||
recomendamos que sea en un lugar como `C:\src\vcpkg` o `C:\dev\vcpkg`,
|
||||
|
||||
ya que de otra forma puede encontrarse problemas de ruta para algunos sistemas de port.
|
||||
|
||||
```cmd
|
||||
> git clone https://github.com/microsoft/vcpkg
|
||||
> .\vcpkg\bootstrap-vcpkg.bat
|
||||
```
|
||||
|
||||
Para instalar las bibliotecas para su proyecto, ejecute:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [paquetes a instalar]
|
||||
```
|
||||
|
||||
también puede buscar bibliotecas que necesite usar el comando `search`:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg search [término de búsqueda]
|
||||
```
|
||||
|
||||
Para poder utilizar vcpkg con Visual Studio,
|
||||
ejecute el siguiente comando (puede requerir privilegios de administrador):
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg integrate install
|
||||
```
|
||||
|
||||
Después de esto, puede crear un nuevo proyecto que no sea de CMake(MSBuild) o abrir uno existente.
|
||||
Todas las bibliotecas estarán listas para ser incluidas y
|
||||
usadas en su proyecto sin configuración adicional.
|
||||
|
||||
Si está usando CMake con Visual Studio,
|
||||
continúe [aquí](#vcpkg-con-proyectos-de-visual-studio\(CMake\)).
|
||||
|
||||
Para utilizar Vcpkg con CMake sin un IDE,
|
||||
puede utilizar el archivo de herramientas incluido:
|
||||
|
||||
```cmd
|
||||
> cmake -B [directorio de compilación] -S . "-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
> cmake --build [directorio de compilación]
|
||||
```
|
||||
|
||||
Con CMake, todavía necesitara `find_package` y las configuraciones adicionales de la biblioteca.
|
||||
Revise la [Sección de Cmake](#usando-vcpkg-con-cmake) para más información,
|
||||
incluyendo el uso de CMake con un IDE.
|
||||
|
||||
### Inicio rápido: Unix
|
||||
|
||||
Prerrequisitos para Linux:
|
||||
|
||||
- [Git][getting-started:git]
|
||||
- [G++/GCC][getting-started:linux-gcc] >= 6
|
||||
|
||||
Prerrequisitos para macOS:
|
||||
|
||||
- [Herramientas de desarrollo de Apple][getting-started:macos-dev-tools]
|
||||
|
||||
Primero, descargue y compile vcpkg, puede ser instalado donde lo desee,
|
||||
pero recomendamos usar vcpkg como un submodulo.
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/microsoft/vcpkg
|
||||
$ ./vcpkg/bootstrap-vcpkg.sh
|
||||
```
|
||||
|
||||
Para instalar las bibliotecas para su proyecto, ejecute:
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg install [paquetes a instalar]
|
||||
```
|
||||
|
||||
Nota: por defecto se instalarán las bibliotecas x86, para instalar x64, ejecute:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [paquete a instalar]:x64-windows
|
||||
```
|
||||
|
||||
O si desea instalar varios paquetes:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [paquetes a instalar] --triplet=x64-windows
|
||||
```
|
||||
|
||||
También puede buscar las bibliotecas que necesita con el subcomando `search`:
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg search [término de búsqueda]
|
||||
```
|
||||
|
||||
Para usar vcpkg con CMake, tiene que usar el siguiente archivo toolchain:
|
||||
|
||||
```sh
|
||||
$ cmake -B [directorio de compilación] -S . "-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
$ cmake --build [directorio de compilación]
|
||||
```
|
||||
|
||||
Con CMake, todavía necesitara `find_package` y las configuraciones adicionales de la biblioteca.
|
||||
Revise la [Sección de CMake](#usando-vcpkg-con-cmake)
|
||||
para más información en cómo aprovechar mejor Vcpkg con CMake,
|
||||
y CMake tools para VSCode.
|
||||
|
||||
Para cualquier otra herramienta, visite la [guía de integración][getting-started:integration].
|
||||
|
||||
### Instalando Herramientas de desarrollo en Linux
|
||||
|
||||
Según las distribuciones de Linux, hay diferentes paquetes
|
||||
que necesitará instalar:
|
||||
|
||||
- Debian, Ubuntu, popOS, y otra distribución basada en Debian:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
Para cualquier otra distribución, asegúrese que dispone de g++ 6 o superior.
|
||||
Si desea añadir instrucción para una distribución específica,
|
||||
[cree un pull request][contributing:submit-pr]
|
||||
|
||||
### Instalando Herramientas de desarrollo en macOS
|
||||
|
||||
En macOS 10.15, solo tiene que ejecutar el siguiente comando en la terminal:
|
||||
|
||||
```sh
|
||||
$ xcode-select --install
|
||||
```
|
||||
|
||||
Luego seguir los pasos que aparecerán en las ventanas que se muestran.
|
||||
|
||||
Posteriormente podrá compilar vcpkg junto con la [guía de inicio rápido](#inicio-rápido-unix)
|
||||
|
||||
### Usando Vcpkg con CMake
|
||||
|
||||
¡Si está usando Vcpkg con CMake, lo siguiente puede ayudar!
|
||||
|
||||
#### Visual Studio Code con CMake Tools
|
||||
|
||||
Agregando lo siguiente al espacio de trabajo `settings.json` permitirá que
|
||||
CMake Tools use automáticamente Vcpkg para las bibliotecas:
|
||||
|
||||
```json
|
||||
{
|
||||
"cmake.configureSettings": {
|
||||
"CMAKE_TOOLCHAIN_FILE": "[raíz de vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Vcpkg con proyectos de Visual Studio(CMake)
|
||||
|
||||
Abra el editor de Ajustes de CMake, bajo la sección `CMake toolchain file`,
|
||||
posteriormente agregue al path el archivo de cadena de herramientas de Vcpkg:
|
||||
|
||||
```sh
|
||||
[raíz de vcpkg]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
#### Vcpkg con CLion
|
||||
|
||||
Abra los ajustes de Cadena de Herramientas (Toolchains)
|
||||
(File > Settings en Windows y Linux, Clion > Preferences en macOS),
|
||||
y entre en la sección de ajustes de CMake (Build, Execution, Deployment > CMake).
|
||||
Finalmente, en `CMake options`, agregue la línea siguiente:
|
||||
|
||||
```sh
|
||||
-DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
Desafortunadamente, tendrá que hacerlo para cada perfil.
|
||||
|
||||
#### Vcpkg como Submódulo
|
||||
|
||||
Cuando este usando Vcpkg como un submódulo para su proyecto,
|
||||
puede agregar lo siguiente as su CMakeLists,txt antes de la primera llamada a `project()`,
|
||||
en vez de pasar `CMAKE_TOOLCHAIN_FILE` a la invocación de CMake.
|
||||
|
||||
```cmake
|
||||
set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "Vcpkg toolchain file")
|
||||
```
|
||||
|
||||
Esto permitirá a las personas no usar Vcpkg,
|
||||
indicando el `CMAKE_TOOLCHAIN_FILE` directamente,
|
||||
sin embargo, hará el proceso de configuración y compilación más sencillo.
|
||||
|
||||
### Inicio rápido: Manifiestos
|
||||
|
||||
Así que desea ver cómo será el futuro de Vcpkg!
|
||||
realmente lo apreciamos. Sin embargo, primero una advertencia:
|
||||
el soporte de archivos de manifiesto aún está en beta,
|
||||
aun así la mayoría debería funcionar,
|
||||
pero no hay garantía de esto y es muy probable que encuentre uno o más bugs
|
||||
mientras use Vcpkg en este modo.
|
||||
Adicionalmente, es probablemente que se rompan comportamientos antes de que se pueda considerar estable,
|
||||
así que está advertido.
|
||||
Por favor [Abra un Problema][contributing:submit-issue] si encuentra algún error
|
||||
|
||||
Primero, instale vcpkg normalmente para [Windows](#inicio-rápido-windows) o
|
||||
[Unix](#inicio-rápido-unix).
|
||||
Puede que desee instalar Vcpkg en un lugar centralizado,
|
||||
ya que el directorio existe localmente,
|
||||
y está bien ejecutar múltiples comandos desde el mismo directorio de vcpkg al mismo tiempo.
|
||||
|
||||
Luego, se requiere activar la bandera de característica `manifests` en vcpkg agregando
|
||||
`manifests` a los valores separados por coma en la opción `--feature-flags`,
|
||||
o agregándole en los valores separados por coma en la variable de entorno `VCPKG_FEATURE_FLAGS`
|
||||
|
||||
también puede que desee agregar Vcpkg al `PATH`.
|
||||
|
||||
Luego, todo lo que hay que hacer es crear un manifiesto;
|
||||
cree un archivo llamado `vcpkg.json`, y escriba lo siguiente:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "<nombre de su proyecto>",
|
||||
"version-string": "<versión de su proyecto>",
|
||||
"dependencies": [
|
||||
"abseil",
|
||||
"boost"
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
Las bibliotecas serán instaladas en el directorio `vcpkg_installed`,
|
||||
en el mismo directorio que su `vcpkg.json`.
|
||||
Si puede usar el regular conjunto de herramientas de CMake,
|
||||
o mediante la integración de Visual Studio/MSBuild,
|
||||
este instalará las dependencias automáticamente,
|
||||
pero necesitará ajustar `VcpkgManifestEnabled` en `On` para MSBuild.
|
||||
Si desea instalar sus dependencias sin usar CMake o MSBuild,
|
||||
puede usar un simple `vcpkg install --feature-flags=manifests`
|
||||
|
||||
Para más información, revise la especificación de [manifiesto][getting-started:manifest-spec]
|
||||
|
||||
[getting-started:using-a-package]: https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages
|
||||
[getting-started:git]: https://git-scm.com/downloads
|
||||
[getting-started:cmake-tools]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools
|
||||
[getting-started:linux-gcc]: #Instalando-Herramientas-de-desarrollo-en-Linux
|
||||
[getting-started:macos-dev-tools]: #Instalando-Herramientas-de-desarrollo-en-macOS
|
||||
[getting-started:visual-studio]: https://visualstudio.microsoft.com/
|
||||
[getting-started:manifest-spec]: https://learn.microsoft.com/en-us/vcpkg/users/manifests
|
||||
|
||||
## Completado-Tab/Autocompletado
|
||||
|
||||
`vcpkg` soporta autocompletado para los comandos, nombres de paquetes,
|
||||
y opciones, tanto en PowerShell como en bash.
|
||||
para activar el autocompletado en la terminal de elección ejecute:
|
||||
|
||||
```pwsh
|
||||
> .\vcpkg integrate powershell
|
||||
```
|
||||
|
||||
o
|
||||
|
||||
```sh
|
||||
$ ./vcpkg integrate bash # o zsh
|
||||
```
|
||||
|
||||
según la terminal que use, luego reinicie la consola.
|
||||
|
||||
## Ejemplos
|
||||
|
||||
ver la [documentación](https://learn.microsoft.com/vcpkg) para tutoriales específicos, incluyendo
|
||||
[instalando y usando un paquete](https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages),
|
||||
[agregando un nuevo paquete desde un archivo comprimido](https://learn.microsoft.com/vcpkg/examples/packaging-zipfiles),
|
||||
[agregando un nuevo paquete desde un repositorio en GitHub](https://learn.microsoft.com/vcpkg/examples/packaging-github-repos).
|
||||
|
||||
Nuestra documentación también esta disponible en nuestro sitio web [vcpkg.io](https://vcpkg.io/).
|
||||
Si necesita ayuda puede [crear un incidente](https://github.com/vcpkg/vcpkg.github.io/issues).
|
||||
¡Apreciamos cualquier retroalimentación!
|
||||
|
||||
Ver un [video de demostración](https://www.youtube.com/watch?v=y41WFKbQFTw) de 4 minutos.
|
||||
|
||||
## Contribuyendo
|
||||
|
||||
Vcpkg es un proyecto de código abierto, y está construido con sus contribuciones.
|
||||
Aquí hay unas de las maneras en las que puede contribuir:
|
||||
|
||||
* [Creando Incidencias][contributing:submit-issue] en vcpkg o paquetes existentes
|
||||
* [Creando Correcciones y Nuevos Paquetes][contributing:submit-pr]
|
||||
|
||||
Por favor visite nuestra [Guía de Contribución](CONTRIBUTING.md) para más detalles.
|
||||
|
||||
Este proyecto ha adoptado el [Código de Conducta de Microsoft de Código Abierto][contributing:coc].
|
||||
Para más información ver [Preguntas frecuentes del Código de Conducta][contributing:coc-faq]
|
||||
o envíe un correo a [opencode@microsoft.com](mailto:opencode@microsoft.com)
|
||||
con cualquier pregunta adicional o comentarios.
|
||||
|
||||
[contributing:submit-issue]: https://github.com/microsoft/vcpkg/issues/new/choose
|
||||
[contributing:submit-pr]: https://github.com/microsoft/vcpkg/pulls
|
||||
[contributing:coc]: https://opensource.microsoft.com/codeofconduct/
|
||||
[contributing:coc-faq]: https://opensource.microsoft.com/codeofconduct/
|
||||
|
||||
## Licencia
|
||||
|
||||
El código en este repositorio se encuentra licenciado mediante la [Licencia MIT](LICENSE.txt).
|
||||
Las bibliotecas proveídas por los `ports` están licenciadas mediante los terminos de los autores originales.
|
||||
Donde estén disponibles, vcpkg almacena las licencias asociadas en la siguiente ubicación `installed/<triplet>/share/<port>/copyright`.
|
||||
|
||||
# Seguridad
|
||||
|
||||
La mayoría de los `ports` en vcpkg construyen las bibliotecas usando su sistema de compilación preferido
|
||||
por los autores originales de las bibliotecas, y descargan el código fuente asi como las herramientas de compilación
|
||||
de sus ubicaciones de distribucion oficiales. Para aquellos que usan un firewall, el acceso dependerá de cuales `ports`
|
||||
están siendo instalados. Si tiene que instalarlos en un entorno aislado, puede instalarlos previamente en un entorno
|
||||
no aislado, generando un [caché del paquete](https://learn.microsoft.com/vcpkg/users/assetcaching) compartido con el entorno aislado.
|
||||
|
||||
## Telemetría
|
||||
|
||||
vcpkg recolecta datos de uso para mejorar su experiencia.
|
||||
La información obtenida por Microsoft es anónima.
|
||||
puede ser dado de baja de la telemetría realizando lo siguiente:
|
||||
|
||||
- ejecutar el script `bootstrap-vcpkg` con el parametro `-disableMetrics`
|
||||
- agregar el parametro `--disable-metrics` a vcpkg en la línea de comandos
|
||||
- agregar la variable de entorno `VCPKG_DISABLE_METRICS`
|
||||
|
||||
Se puede leer más sobre la telemetría de vcpkg en [https://learn.microsoft.com/vcpkg/about/privacy](https://learn.microsoft.com/vcpkg/about/privacy).
|
||||
311
README_fr.md
311
README_fr.md
@ -1,311 +0,0 @@
|
||||
# Vcpkg: Vue d'ensemble
|
||||
|
||||
[中文总览](README_zh_CN.md)
|
||||
[Español](README_es.md)
|
||||
|
||||
Vcpkg vous aide à gérer vos bibliothèques C et C++ sur Windows, Linux et MacOS.
|
||||
L'outil et l'écosystème sont en évolution constante, et nous apprécions vos contributions!
|
||||
|
||||
Si vous n'avez jamais utilisé vcpkg, ou si vous essayez d'utiliser vcpkg, lisez notre [introduction](#introduction) pour comprendre comment l'utiliser.
|
||||
|
||||
Pour une description des commandes disponibles, quand vous avez installé vcpkg, vous pouvez lancer `vcpkg help` ou `vcpkg help [commande]` pour de l'aide spécifique à une commande.
|
||||
|
||||
|
||||
* GitHub: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg)
|
||||
* Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/), the #vcpkg channel
|
||||
* Discord: [\#include \<C++\>](https://www.includecpp.org), le canal #🌏vcpkg
|
||||
* Docs: [Documentation](https://learn.microsoft.com/vcpkg)
|
||||
|
||||
[](https://dev.azure.com/vcpkg/public/_build/latest?definitionId=29&branchName=master)
|
||||
|
||||
# Sommaire
|
||||
|
||||
- [Vcpkg: Vue d'ensemble](#vcpkg-vue-d'ensemble)
|
||||
- [Sommaire](#Sommaire)
|
||||
- [Introduction](#introduction)
|
||||
- [Introduction Windows](#Introduction:-Windows)
|
||||
- [Introduction Unix](#Introduction-aux-Systèmes-Unix)
|
||||
- [Installer les prérequis pour linux](#installation-des-prérequis-linux)
|
||||
- [Installer les prérequis pour macOS](#installation-des-prérequis-macos)
|
||||
- [Installer GCC pour macOS avant 10.15](#installer-gcc-pour-macos-avant-10.15)
|
||||
- [Utiliser vcpkg avec CMake](#utiliser-vcpkg-avec-cmake)
|
||||
- [Visual Studio Code avec CMake Tools](#visual-studio-code-avec-cmake-tools)
|
||||
- [Vcpkg avec Visual Studio pour un projet CMake](#vcpkg-avec-visual-studio-un-projet-cmake)
|
||||
- [Vcpkg avec CLion](#vcpkg-avec-clion)
|
||||
- [Vcpkg en tant que sous module](#vcpkg-en-tant-que-sous-module)
|
||||
- [Tab-Completion/Auto-Completion](#tab-complétionauto-complétion)
|
||||
- [Exemples](#exemples)
|
||||
- [Contribuer](#contribuer)
|
||||
- [Licence](#licence)
|
||||
- [Télémétrie](#Télémétrie)
|
||||
|
||||
# Introduction
|
||||
|
||||
Premièrement, suivez le guide d'introduction [Windows](#Introduction:-Windows), ou [macOS et Linux](#Unix), en fonction de vos besoins.
|
||||
|
||||
Pour plus d'information, regardez [utiliser des paquets][getting-started:utiliser-un-paquet].
|
||||
Si la bibliothèque dont vous avez besoin n'est pas présente dans la liste, vous pouvez [ouvrir une issue sur le repo github](contribuer:faire-une-issue) où l'équipe de vcpkg et la communauté peuvent le voir, et possiblement ajouter le port de vcpkg.
|
||||
|
||||
Après avoir installé et lancé vcpkg vous pourriez vouloir ajouter [l'auto-complétion](auto-completion) à votre shell.
|
||||
|
||||
Si vous êtes intéressé par le futur de vcpkg, regardez le guide du [manifeste][getting-started:manifest-spec] !
|
||||
C'est une fonctionnalité expérimentale et possiblement boguée, donc essayez d'[ouvrir des issues](contribuer:envoyer-une-issue) !
|
||||
|
||||
# Introduction: Windows
|
||||
Prérequis :
|
||||
- Windows 7 ou plus
|
||||
- [Git][getting-started:git]
|
||||
+ [Visual Studio][getting-started:visualstudio] 2015 mise à jour 3 où plus récente avec le pack de langue Anglais
|
||||
|
||||
Premièrement, téléchargez et lancer le fichier bootstrap-vcpkg; il peut être installé n'importe où mais il est recommandé d'utiliser vcpkg pour des projets CMake. Nous recommandons ces chemins `C:\src\vcpkg` ou `C:\dev\vcpkg`, sinon vous pourriez avoir des problèmes de chemin pour certaines compilations.
|
||||
|
||||
|
||||
```cmd
|
||||
> git clone https://github.com/microsoft/vcpkg
|
||||
> .\vcpkg\bootstrap-vcpkg.bat
|
||||
```
|
||||
|
||||
Pour installer des bibliothèques pour votre projet, lancez:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [paquets à installer]
|
||||
```
|
||||
|
||||
Vous pouvez aussi chercher la bibliothèque dont vous avez besoin avec l'argument `search`:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg search [terme de recherche]
|
||||
```
|
||||
|
||||
|
||||
Pour utiliser vcpkg avec Visual Studio, lancez cette commande (pourrait nécessiter d'être lancée avec les droits administrateur)
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg integrate install
|
||||
```
|
||||
|
||||
Ensuite, vous pouvez créer un nouveau projet n'utilisant pas CMake (ou en ouvrir un préexistant).
|
||||
Toutes les bibliothèques installées sont directement prêtes à être `#include` et utilisées sans davantage de configuration.
|
||||
|
||||
Si vous utilisez CMake avec Visual Studio continuez [ici](#vcpkg-avec-cmake-et-visual-studio).
|
||||
|
||||
Afin d'utiliser vcpkg en dehors d'un IDE, vous pouvez utiliser le fichier de toolchain :
|
||||
|
||||
```cmd
|
||||
> cmake -B [dossier de build] -S . "-DCMAKE_TOOLCHAIN_FILE=[chemin vers vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
> cmake --build [dossier de build]
|
||||
```
|
||||
|
||||
Avec CMake, vous devrez utiliser `find_package` notamment, et autres, pour compiler.
|
||||
|
||||
Regardez la [section CMake](#utiliser-vcpkg-avec-cmake) pour plus d'information, notamment utiliser CMake avec un IDE.
|
||||
|
||||
Pour les autres éditeurs, y compris Visual Studio Code regardez le [guide d'intégration](getting-started:integration).
|
||||
|
||||
|
||||
## Introduction aux Systèmes Unix
|
||||
|
||||
Prérequis pour Linux :
|
||||
- [Git][getting-started:git]
|
||||
- [g++][getting-started:linux-gcc] >= 6
|
||||
|
||||
Prérequis pour macOS:
|
||||
- [Outils de développement Apple][getting-started:macos-dev-tools]
|
||||
- Pour macOS 10.14 et en dessous, vous aurez besoin de:
|
||||
- [Homebrew][getting-started:macos-brew]
|
||||
- [g++][getting-started:macos-gcc] >= 6
|
||||
|
||||
Premièrement, clonez et lancez le bootstrap vcpkg; il peut être installé n'importe où mais il est recommandé de l'utiliser comme un sous-module pour projets CMake.
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/microsoft/vcpkg
|
||||
$ ./vcpkg/bootstrap-vcpkg.sh
|
||||
```
|
||||
|
||||
Pour installer des bibliothèques pour votre projet, lancez :
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg install [paquets à installer]
|
||||
```
|
||||
|
||||
Vous pouvez aussi chercher la bibliothèque dont vous avez besoin avec l'argument `search` :
|
||||
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg search [terme de recherche]
|
||||
```
|
||||
|
||||
Pour utiliser vcpkg en dehors d'un IDE, vous pouvez utiliser le fichier de toolchain :
|
||||
|
||||
```cmd
|
||||
> cmake -B [dossier de build] -S . "-DCMAKE_TOOLCHAIN_FILE=[chemin vers vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
> cmake --build [dossier de build]
|
||||
```
|
||||
|
||||
Avec CMake, vous devrez utiliser `find_package` notamment, et autres, pour compiler.
|
||||
|
||||
Lisez la [section CMake](#utiliser-vcpkg-avec-cmake) pour plus d'information, notamment utiliser CMake avec un IDE.
|
||||
|
||||
Pour les autres éditeurs, y compris Visual Studio Code lisez le [guide d'intégration][getting-started:integration].
|
||||
|
||||
## Installation des prérequis linux
|
||||
|
||||
Pour les différentes distros Linux, il y a différents paquets que vous aurez besoin d'installer :
|
||||
|
||||
- Debian, Ubuntu, popOS, et les autres distros basées sur Debian :
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
Pour les autres distributions, installez au minimum g++ 6.
|
||||
Si vous voulez ajouter des instructions spécifiques pour votre distro, [ouvrez une PR svp][contribuer:faire-une-pr] !
|
||||
|
||||
## Installation des prérequis macOS
|
||||
|
||||
Pour macOS 10.15, la seule chose dont vous avez besoin est de lancer cette commande :
|
||||
|
||||
```sh
|
||||
$ xcode-select --install
|
||||
```
|
||||
|
||||
Ensuite suivez les instructions qui s'afficheront dans la fenêtre.
|
||||
|
||||
Pour macOS 10.14 et les versions précédentes, vous aurez besoin d'installer g++ avec homebrew; suivez les instructions dans la section suivante.
|
||||
|
||||
### Installer GCC pour macOS antérieur à 10.15
|
||||
|
||||
Cette partie est seulement nécessaire si vous avez une version de macOS antérieure à 10.15.
|
||||
|
||||
Installer homebrew devrait être très simple; pour plus d'informations allez sur <brew.sh>, mais le plus simple est de lancer la commande suivante :
|
||||
|
||||
```sh
|
||||
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
|
||||
```
|
||||
|
||||
Ensuite, afin d'obtenir une version à jour de gcc, lancez la commande suivante :
|
||||
|
||||
```sh
|
||||
$ brew install gcc
|
||||
```
|
||||
|
||||
Ensuite suivez l'[introduction Unix](#Introduction-aux-Systèmes-Unix)
|
||||
|
||||
## Utiliser vcpkg avec CMake
|
||||
|
||||
Si vous utilisez vcpkg avec CMake, la suite pourrait vous aider !
|
||||
|
||||
## Visual Studio Code avec CMake tools
|
||||
|
||||
```json
|
||||
{
|
||||
"cmake.configureSettings": {
|
||||
"CMAKE_TOOLCHAIN_FILE": "[vcpkg root]/scripts/buildsystems/vcpkg.cmake"
|
||||
}
|
||||
}
|
||||
```
|
||||
### Vcpkg avec des projets CMake Visual Studio
|
||||
|
||||
Ouvrez les paramètres CMake, et ajoutez le chemin ci-dessous à `CMake toolchain file` :
|
||||
|
||||
```
|
||||
[vcpkg root]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
### Vcpkg avec CLion
|
||||
|
||||
Ouvrez les paramètres de Toolchains (File > Settings sur Windows et Linux, CLion > Preference pour macOS) et allez dans les paramètres CMake (Build, Execution, Deployment > CMake).
|
||||
Finalement, dans `CMake options`, ajoutez la ligne suivante :
|
||||
|
||||
```
|
||||
-DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
Malheureusement, vous devrez le refaire pour chaque projet.
|
||||
|
||||
|
||||
### Vcpkg en tant que sous-module
|
||||
|
||||
Quand vous utilisez vcpkg comme un sous-module de votre projet, vous pouvez l'ajouter à votre CMakeLists.txt avant le premier appel de `project()`, au lieu d'utiliser `CMAKE_TOOLCHAIN_FILE` dans les paramètres d'appel de cmake.
|
||||
|
||||
```cmake
|
||||
set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "Vcpkg toolchain file")
|
||||
```
|
||||
|
||||
Cela permettra toujours aux gens de ne pas utiliser vcpkg, en passant directement le CMAKE_TOOLCHAIN_FILE, mais cela rendra l'étape de configuration-construction légèrement plus facile.
|
||||
|
||||
[getting-started:utiliser-un-paquet]: https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages
|
||||
[getting-started:integration]: https://learn.microsoft.com/en-us/vcpkg/users/buildsystems/msbuild-integration
|
||||
[getting-started:git]: https://git-scm.com/downloads
|
||||
[getting-started:cmake-tools]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools
|
||||
[getting-started:linux-gcc]: #installing-linux-developer-tools
|
||||
[getting-started:macos-dev-tools]: #installing-macos-developer-tools
|
||||
[getting-started:macos-brew]: #installing-gcc-on-macos
|
||||
[getting-started:macos-gcc]: #installing-gcc-on-macos
|
||||
[getting-started:visual-studio]: https://visualstudio.microsoft.com/
|
||||
[getting-started:manifest-spec]: https://learn.microsoft.com/en-us/vcpkg/users/manifests
|
||||
|
||||
# Tab-complétion/Auto-complétion
|
||||
|
||||
`vcpkg` supporte l'auto-complétion des commandes, nom de paquets, et options dans powershell et bash.
|
||||
Pour activer la tab-complétion dans le shell de votre choix :
|
||||
|
||||
```pwsh
|
||||
> .\vcpkg integrate powershell
|
||||
```
|
||||
|
||||
ou
|
||||
|
||||
```sh
|
||||
$ ./vcpkg integrate bash
|
||||
```
|
||||
|
||||
selon le shell que vous utilisez, puis redémarrez la console.
|
||||
|
||||
# Exemples
|
||||
|
||||
Lisez la [documentation](https://learn.microsoft.com/vcpkg) pour des instructions plus spécifiques ainsi que [l'installation et l'utilisation des paquets](https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages),
|
||||
[ajouter un nouveau paquet depuis un fichier zip](https://learn.microsoft.com/vcpkg/examples/packaging-zipfiles),
|
||||
et [ajouter un nouveau paquet depuis un dépôt GitHub](https://learn.microsoft.com/vcpkg/examples/packaging-github-repos).
|
||||
|
||||
La documentation est aussi disponible en ligne sur ReadTheDocs : <https://vcpkg.readthedocs.io/> !
|
||||
|
||||
Regardez une [démo vidéo]((https://www.youtube.com/watch?v=y41WFKbQFTw) de 4 minutes en anglais.
|
||||
|
||||
# Contribuer
|
||||
|
||||
Vcpkg est un projet open source, et évolue ainsi avec vos contributions.
|
||||
Voici quelques moyens pour vous d'y contribuer :
|
||||
* [Soumettre des Issues][contributing:submit-issue] sur vcpkg ou des paquets existants
|
||||
* [Proposer des corrections et de nouveaux paquets][contributing:submit-pr]
|
||||
|
||||
|
||||
Veuillez vous référer au [guide de contribution](CONTRIBUTING.md) pour plus de détails.
|
||||
|
||||
|
||||
Ce projet a adopté le [Code de Conduite Open Source de Microsoft][contribuer:coc].
|
||||
[contributing:submit-issue]: https://github.com/microsoft/vcpkg/issues/new/choose
|
||||
[contributing:submit-pr]: https://github.com/microsoft/vcpkg/pulls
|
||||
[contributing:coc]: https://opensource.microsoft.com/codeofconduct/
|
||||
[contributing:coc-faq]: https://opensource.microsoft.com/codeofconduct/
|
||||
|
||||
# Licence
|
||||
Le code sur ce dépôt est distribué sous [licence MIT](LICENSE.txt).
|
||||
|
||||
# Télémétrie
|
||||
|
||||
vcpkg collecte des données pour nous aider à améliorer votre expérience.
|
||||
Les données collectées par Microsoft sont anonymes.
|
||||
Vous pouvez désactiver la télémétrie en relançant le bootstrap-vcpkg avec l'argument `-disableMetrics`, passer l'argument `--disable-metrics` à chaque exécution de vcpkg, ou en créant une variable d'environnement nommée `VCPKG_DISABLE_METRICS`.
|
||||
|
||||
Vous trouverez plus d'informations à propos de la télémétrie dans vcpkg sur cette [page](https://learn.microsoft.com/vcpkg/about/privacy).
|
||||
346
README_ko_KR.md
346
README_ko_KR.md
@ -1,346 +0,0 @@
|
||||
# Vcpkg: 개요
|
||||
|
||||
[中文总览](README_zh_CN.md)
|
||||
[Español](README_es.md)
|
||||
[English](README.md)
|
||||
[Français](README_fr.md)
|
||||
|
||||
Vcpkg는 Windows, Linux 및 MacOS에서 C 및 C++ 라이브러리를 관리하는 데 도움을 주는 라이브러리입니다.
|
||||
이 도구와 생태계는 지속적으로 진화하고 있으며, 저희는 기여를 언제나 환영합니다!
|
||||
|
||||
이전에 vcpkg를 사용한 적이 없거나 vcpkg를 사용하는 방법을 알고 싶을 경우,
|
||||
아래의 [시작하기](#시작하기) 단락을 확인하면 vcpkg 사용을 시작하는 방법이 설명되어 있습니다.
|
||||
|
||||
Vcpkg를 설치하였다면, `vcpkg help` 명령어로 사용 가능한 명령어에 대한 간단한 설명을 볼 수 있습니다.
|
||||
`vcpkg help [command]` 명령어로는 각 명령어별 도움말을 볼 수 있습니다.
|
||||
|
||||
* GitHub: port는 [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg)에, 관련 프로그램은 [https://github.com/microsoft/vcpkg-tool](https://github.com/microsoft/vcpkg-tool)에 있습니다.
|
||||
* Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/), #vcpkg 채널
|
||||
* Discord: [\#include \<C++\>](https://www.includecpp.org), #🌏vcpkg 채널
|
||||
* 도움말: [Documentation](https://learn.microsoft.com/vcpkg)
|
||||
|
||||
# 목차
|
||||
|
||||
- [Vcpkg: 개요](#vcpkg-개요)
|
||||
- [목차](#목차)
|
||||
- [시작하기](#시작하기)
|
||||
- [빠르게 시작하기: Windows](#빠르게-시작하기-windows)
|
||||
- [빠르게 시작하기: Unix](#빠르게-시작하기-unix)
|
||||
- [Linux 개발자 도구 설치하기](#linux-개발자-도구-설치하기)
|
||||
- [macOS 개발자 도구 설치하기](#macos-개발자-도구-설치하기)
|
||||
- [CMake와 함께 vcpkg 사용](#cmake와-함께-vcpkg-사용)
|
||||
- [Visual Studio Code와 CMake Tools](#visual-studio-code와-cmake-tools)
|
||||
- [Vcpkg와 Visual Studio CMake 프로젝트](#vcpkg와-visual-studio-cmake-프로젝트)
|
||||
- [Vcpkg와 CLion](#vcpkg와-clion)
|
||||
- [서브모듈로 vcpkg 사용하기](#서브모듈로-vcpkg-사용하기)
|
||||
- [탭 완성/자동 완성](#탭-완성자동-완성)
|
||||
- [예시](#예시)
|
||||
- [기여하기](#기여하기)
|
||||
- [라이선스](#라이선스)
|
||||
- [보안](#보안)
|
||||
- [데이터 수집](#데이터-수집)
|
||||
|
||||
# 시작하기
|
||||
|
||||
먼저, 사용하는 운영체제에 따라
|
||||
[윈도우](#빠르게-시작하기-windows) 또는 [macOS와 Linux](#빠르게-시작하기-unix)
|
||||
빠르게 시작하기 가이드를 따라가세요.
|
||||
|
||||
더 자세한 정보는 [패키지 설치 및 사용][getting-started:using-a-package]에 있습니다.
|
||||
만약 필요한 라이브러리가 vcpkg 카탈로그에 없는 경우,
|
||||
[GitHub 저장소에서 이슈를 열 수 있습니다][contributing:submit-issue].
|
||||
Vcpkg 팀과 커뮤니티가 이슈를 확인하면, 해당하는 port를 추가할 수 있습니다.
|
||||
|
||||
Vcpkg의 설치가 완료되었다면,
|
||||
셸에 [탭 완성](#탭-완성자동-완성)을 추가할 수 있습니다.
|
||||
|
||||
마지막으로, vcpkg의 미래에 관심이 있다면,
|
||||
[manifest][getting-started:manifest-spec] 가이드를 확인하세요!
|
||||
이것은 실험적인 기능이며 버그가 있을 가능성이 높습니다.
|
||||
시도해보고 문제가 있다면 [이슈를 열어주세요][contributing:submit-issue]!
|
||||
|
||||
## 빠르게 시작하기: Windows
|
||||
|
||||
필요조건:
|
||||
- Windows 7 이상
|
||||
- [Git][getting-started:git]
|
||||
- [Visual Studio][getting-started:visual-studio] 영어 언어팩이 설치된 2015 Update 3 버전 이상
|
||||
|
||||
첫번째로, vcpkg 자체를 다운로드하고 부트스트랩합니다. Vcpkg는 어디에나 설치할 수 있지만,
|
||||
일반적으로 CMake 프로젝트는 vcpkg를 submodule로 사용하는 것을,
|
||||
Visual Studio 프로젝트는 시스템에 설치하는 것을 추천합니다.
|
||||
시스템 설치는 `C:\src\vcpkg` 나 `C:\dev\vcpkg` 등의 위치에 하는 것을 권장하는데,
|
||||
그렇지 않으면 일부 포트 빌드 시스템에서 경로 문제가 발생할 수도 있기 때문입니다.
|
||||
|
||||
```cmd
|
||||
> git clone https://github.com/microsoft/vcpkg
|
||||
> .\vcpkg\bootstrap-vcpkg.bat
|
||||
```
|
||||
|
||||
당신의 프로젝트에 라이브러리를 설치하려면 다음 명령을 실행하세요.
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [packages to install]
|
||||
```
|
||||
|
||||
참고로, 위 명령은 x86 라이브러리를 설치하는 것이 기본 설정입니다. 만약 x64 버전을
|
||||
설치하고 싶다면, 다음 명령을 실행하세요.
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [package name]:x64-windows
|
||||
```
|
||||
|
||||
또는 이렇게도 가능합니다.
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [packages to install] --triplet=x64-windows
|
||||
```
|
||||
|
||||
다음과 같이 `search` 하위 명령어를 사용하여 필요한 라이브러리를 검색할 수도 있습니다.
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg search [search term]
|
||||
```
|
||||
|
||||
Visual Studio에서 vcpkg를 사용하려면
|
||||
다음 명령을 실행해야 합니다(관리자 권한이 필요할 수도 있습니다).
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg integrate install
|
||||
```
|
||||
|
||||
이제 CMake를 사용하지 않는 프로젝트도 만들 수 (또는 기존 프로젝트를 열 수) 있습니다.
|
||||
설치한 모든 라이브러리는 추가 설정 없이도 프로젝트에서 즉시 `# include` 및 사용할 수 있습니다.
|
||||
|
||||
Visual Studio에서 CMake를 사용하는 경우,
|
||||
[여기를 보세요](#vcpkg와-visual-studio-cmake-프로젝트).
|
||||
|
||||
IDE 외부에서 CMake와 함께 vcpkg를 사용하려면,
|
||||
다음과 같이 툴체인 파일을 사용할 수 있습니다.
|
||||
|
||||
```cmd
|
||||
> 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 섹션](#cmake와-함께-vcpkg-사용)을 확인하세요.
|
||||
|
||||
Visual Studio Code를 포함한 다른 툴의 경우
|
||||
[통합 가이드][getting-started:integration]를 확인하세요.
|
||||
|
||||
## 빠르게 시작하기: Unix
|
||||
|
||||
Linux에서의 필요조건:
|
||||
- [Git][getting-started:git]
|
||||
- [g++][getting-started:linux-gcc] >= 6
|
||||
|
||||
macOS에서의 필요조건:
|
||||
- [Apple Developer Tools][getting-started:macos-dev-tools]
|
||||
|
||||
우선, vcpkg 자체를 다운로드하고 설치해야 합니다. 어디에나 설치할 수 있지만,
|
||||
일반적으로 CMake 프로젝트의 하위 모듈로 vcpkg를 사용하는 것이 좋습니다.
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/microsoft/vcpkg
|
||||
$ ./vcpkg/bootstrap-vcpkg.sh
|
||||
```
|
||||
|
||||
프로젝트에 라이브러리를 설치하려면 다음 명령을 실행하세요.
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg install [packages to install]
|
||||
```
|
||||
|
||||
다음과 같이 `search` 하위 명령어를 사용하여 필요한 라이브러리를 검색할 수도 있습니다.
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg search [search term]
|
||||
```
|
||||
|
||||
CMake와 함께 vcpkg를 사용하려면 툴체인 파일을 이용해 보세요.
|
||||
|
||||
```sh
|
||||
$ 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 섹션](#cmake와-함께-vcpkg-사용)을 확인하세요.
|
||||
|
||||
다른 툴에 대해서는 [통합 가이드][getting-started:integration]를 확인하세요.
|
||||
|
||||
## Linux 개발자 도구 설치하기
|
||||
|
||||
Linux의 배포판별로 설치해야 하는 개발자 소프트웨어가 다릅니다.
|
||||
|
||||
- Debian, Ubuntu, popOS 및 기타 Debian 기반 배포판
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
다른 배포판의 경우, g++ 6 이상의 버전을 설치하여야 합니다.
|
||||
특정 배포판에 대한 안내를 추가하고 싶은 경우,
|
||||
[PR을 열어주세요][contributing:submit-pr]!
|
||||
|
||||
## macOS 개발자 도구 설치하기
|
||||
|
||||
macOS에서는 터미널에서 다음 명령어를 실행하기만 하면 됩니다.
|
||||
|
||||
```sh
|
||||
$ xcode-select --install
|
||||
```
|
||||
|
||||
그런 다음 나타나는 창의 안내에 따르세요.
|
||||
|
||||
설치가 끝나면 [빠른 시작 가이드](#빠르게-시작하기-unix)를 참고하여 vcpkg를 설치하세요.
|
||||
|
||||
## CMake와 함께 vcpkg 사용
|
||||
|
||||
CMake와 함께 vcpkg를 사용하는 경우, 다음 내용이 도움이 될 것입니다!
|
||||
|
||||
### Visual Studio Code와 CMake Tools
|
||||
|
||||
Workspace `settings.json` 파일에 다음을 추가하면
|
||||
CMake Tools는 자동으로 vcpkg의 라이브러리를 사용할 것입니다.
|
||||
|
||||
```json
|
||||
{
|
||||
"cmake.configureSettings": {
|
||||
"CMAKE_TOOLCHAIN_FILE": "[vcpkg root]/scripts/buildsystems/vcpkg.cmake"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Vcpkg와 Visual Studio CMake 프로젝트
|
||||
|
||||
CMake 설정 편집기를 열고 `CMake toolchain file`에서
|
||||
vcpkg 툴체인 파일에 경로를 추가합니다.
|
||||
|
||||
```
|
||||
[vcpkg root]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
### Vcpkg와 CLion
|
||||
|
||||
Toolchains settings을 엽니다.
|
||||
(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를 사용하는 경우,
|
||||
cmake 실행 시 `CMAKE_TOOLCHAIN_FILE`을 전달하는 대신,
|
||||
첫 번째 `project()` 호출 전에 CMakeLists.txt에 다음을 추가하는 방법도 있습니다.
|
||||
|
||||
```cmake
|
||||
set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "Vcpkg toolchain file")
|
||||
```
|
||||
|
||||
이렇게 하면 설정-빌드 단계가 약간 더 쉬워집니다.
|
||||
또한, 여전히 `CMAKE_TOOLCHAIN_FILE`을 직접 전달하면
|
||||
vcpkg를 사용하지 않을 수 있습니다.
|
||||
|
||||
[getting-started:using-a-package]: https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages
|
||||
[getting-started:integration]: https://learn.microsoft.com/en-us/vcpkg/users/buildsystems/msbuild-integration
|
||||
[getting-started:git]: https://git-scm.com/downloads
|
||||
[getting-started:cmake-tools]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools
|
||||
[getting-started:linux-gcc]: #installing-linux-developer-tools
|
||||
[getting-started:macos-dev-tools]: #installing-macos-developer-tools
|
||||
[getting-started:macos-brew]: #installing-gcc-on-macos
|
||||
[getting-started:macos-gcc]: #installing-gcc-on-macos
|
||||
[getting-started:visual-studio]: https://visualstudio.microsoft.com/
|
||||
[getting-started:manifest-spec]: https://learn.microsoft.com/en-us/vcpkg/users/manifests
|
||||
|
||||
# 탭 완성/자동 완성
|
||||
|
||||
`vcpkg`는 powershell과 bash 모두에서 명령, 패키지 이름 및 옵션의 자동 완성을 지원합니다.
|
||||
선택한 셸에서 탭 완성을 활성화하려면 다음 두 명령어 중 하나를 실행합니다.
|
||||
|
||||
```pwsh
|
||||
> .\vcpkg integrate powershell
|
||||
```
|
||||
|
||||
```sh
|
||||
$ ./vcpkg integrate bash # or zsh
|
||||
```
|
||||
|
||||
그 다음 콘솔을 재시작하세요.
|
||||
|
||||
# 예시
|
||||
|
||||
[패키지 설치 및 사용](https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages),
|
||||
[zip 파일에서 새 패키지 추가](https://learn.microsoft.com/vcpkg/examples/packaging-zipfiles),
|
||||
[GitHub 저장소에서 새 패키지 추가](https://learn.microsoft.com/vcpkg/examples/packaging-github-repos)에
|
||||
대한 구체적인 예시는 [문서](https://learn.microsoft.com/vcpkg)를 참고하세요.
|
||||
|
||||
문서는 이제 웹사이트 https://vcpkg.io/ 에서도 온라인으로 확인 가능합니다. 모든 피드백에 진심으로 감사드립니다!
|
||||
https://github.com/vcpkg/vcpkg.github.io/issues 에서 이슈를 제출할 수 있습니다.
|
||||
|
||||
[4분짜리 데모 영상도 준비되어 있습니다](https://www.youtube.com/watch?v=y41WFKbQFTw).
|
||||
|
||||
# 기여하기
|
||||
|
||||
Vcpkg는 오픈소스 프로젝트입니다, 따라서 여러분의 기여를 통해 만들어집니다.
|
||||
기여할 수 있는 몇 가지 방법은 다음과 같습니다.
|
||||
|
||||
* Vcpkg 또는 vcpkg에 포함된 패키지의 [이슈 제출][contributing:submit-issue]
|
||||
* [수정 사항 및 새 패키지 제출][contributing:submit-pr]
|
||||
|
||||
자세한 내용은 [기여 가이드](CONTRIBUTING.md)를 참고하세요.
|
||||
|
||||
이 프로젝트는 [Microsoft Open Source Code of Conduct][contributing:coc]을 채택했습니다.
|
||||
더 많은 정보를 얻고 싶다면 [Code of Conduct FAQ][contributing:coc-faq] 문서를 참고하세요.
|
||||
추가 질문이나 의견은 이메일 [opencode@microsoft.com](mailto:opencode@microsoft.com)로 보내주세요.
|
||||
|
||||
[contributing:submit-issue]: https://github.com/microsoft/vcpkg/issues/new/choose
|
||||
[contributing:submit-pr]: https://github.com/microsoft/vcpkg/pulls
|
||||
[contributing:coc]: https://opensource.microsoft.com/codeofconduct/
|
||||
[contributing:coc-faq]: https://opensource.microsoft.com/codeofconduct/
|
||||
|
||||
# 라이선스
|
||||
|
||||
이 저장소의 코드는 [MIT 라이선스](LICENSE.txt)에 따라 사용이 허가됩니다. Port로 제공되는
|
||||
라이브러리는 각 라이브러리의 원저자가 설정한 라이선스에 따라 제공됩니다. 가능한 경우, vcpkg는
|
||||
`installed/<triplet>/share/<port>/copyright`에 관련된 라이선스를 저장합니다.
|
||||
|
||||
# 보안
|
||||
|
||||
Vcpk가 제공하는 대부분의 port는 각각의 라이브러리를 빌드할 때
|
||||
원 개발자들이 권장하는 빌드 시스템을 이용하고,
|
||||
소스 코드와 빌드 도구를 각각의 공식 배포처로부터 다운로드합니다.
|
||||
방화벽 뒤에서 사용하는 경우, 어떤 port를 설치하느냐에 따라 필요한 접근 권한이 달라질 수 있습니다.
|
||||
만약 "air gapped" 환경에서 설치해야만 한다면, "air gapped"가 아닌 환경에서
|
||||
[asset 캐시](https://learn.microsoft.com/vcpkg/users/assetcaching)를 다운로드하고,
|
||||
이후에 "air gapped" 환경에서 공유하는 것을 고려해 보십시오.
|
||||
|
||||
# 데이터 수집
|
||||
|
||||
vcpkg는 사용자 경험을 개선하는 데 도움이 되도록 사용 데이터를 수집합니다.
|
||||
Microsoft는 이 정보를 익명으로 수집합니다.
|
||||
다음을 통해 원격 정보 제공을 비활성화할 수 있습니다.
|
||||
- -disableMetrics 옵션을 포함하여 bootstrap-vcpkg 스크립트 실행
|
||||
- 명령줄에서 vcpkg에 --disable-metrics 전달
|
||||
- VCPKG_DISABLE_METRICS 환경 변수 설정
|
||||
|
||||
[https://learn.microsoft.com/vcpkg/about/privacy](https://learn.microsoft.com/vcpkg/about/privacy)에서 vcpkg 데이터 수집에 대해 자세히 알아보세요.
|
||||
334
README_pt.md
334
README_pt.md
@ -1,334 +0,0 @@
|
||||
# Vcpkg: visão geral
|
||||
|
||||
[中文总览](README_zh_CN.md) |
|
||||
[Español](README_es.md) |
|
||||
[한국어](README_ko_KR.md) |
|
||||
[Français](README_fr.md) |
|
||||
[English](README.md)
|
||||
|
||||
Vcpkg ajuda você a gerenciar bibliotecas C e C++ no Windows, Linux e MacOS.
|
||||
Esta ferramenta e ecossistema estão em constante evolução e sempre agradecemos as contribuições!
|
||||
|
||||
Se você nunca usou o vcpkg antes, ou se está tentando descobrir como usar o vcpkg,
|
||||
confira nossa seção [Primeiros passos](#getting-started) para saber como começar a usar o vcpkg.
|
||||
|
||||
Para obter uma breve descrição dos comandos disponíveis, depois de instalar o vcpkg,
|
||||
você pode executar `vcpkg help`, ou `vcpkg help [command]` para obter ajuda específica do comando.
|
||||
|
||||
* GitHub: pacote completo em [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg), programa em [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
|
||||
* Documentos: [Documentation](https://learn.microsoft.com/vcpkg)
|
||||
|
||||
# Índice
|
||||
|
||||
* [Vcpkg: visão geral](#vcpkg-visão-geral)
|
||||
* [Índice](#Índice)
|
||||
* [Primeiros passos](#primeiros-passos)
|
||||
* [Início rápido: Windows](#início-rápido-windows)
|
||||
* [Início rápido: Unix](#início-rápido-unix)
|
||||
* [Instalando ferramentas de desenvolvedor do Linux](#Instalando-ferramentas-de-desenvolvedor-do-Linux)
|
||||
* [Instalando ferramentas de desenvolvedor do macOS](#instalando-ferramentas-de-desenvolvedor-do-macos)
|
||||
* [Usando vcpkg com CMake](#usando-vcpkg-com-cmake)
|
||||
* [Visual Studio Code com CMake Tools](#visual-studio-code-com-ferramentas-cmake)
|
||||
* [Vcpkg com Projectos Visual Studio CMake](#vcpkg-com-projectos-visual-studio-cmake)
|
||||
* [Vcpkg com CLion](#vcpkg-com-clion)
|
||||
* [Vcpkg como um submódulo](#vcpkg-como-um-submódulo)
|
||||
* [Tab-Completion/Auto-Completion](#tab-completionauto-completion)
|
||||
* [Exemplos](#exemplos)
|
||||
* [Contribuindo](#contribuindo)
|
||||
* [Licença](#licença)
|
||||
* [Segurança](#segurança)
|
||||
* [Telemetria](#telemetria)
|
||||
|
||||
# Primeiros passos
|
||||
|
||||
Primeiro, siga o guia de início rápido para
|
||||
[Windows](#início-rápido-windows) ou [macOS e Linux](#início-rápido-unix),
|
||||
dependendo do que você está usando.
|
||||
|
||||
Para obter mais informações, consulte [Instalando e usando pacotes] [primeiros passos: usando um pacote].
|
||||
Se uma biblioteca que você precisa não estiver presente no catálogo vcpkg,
|
||||
você pode [abrir um problema no repositório do GitHub][contributing:submit-issue]
|
||||
onde a equipe e a comunidade do vcpkg possam vê-lo,
|
||||
e potencialmente adicionar a porta ao vcpkg.
|
||||
|
||||
Depois de ter vcpkg instalado e funcionando,
|
||||
você pode querer adicionar [tab-completion](#tab-completionauto-completion) ao seu shell.
|
||||
|
||||
Finalmente, se você estiver interessado no futuro do vcpkg,
|
||||
confira o guia [manifesto][introdução: especificação do manifesto]!
|
||||
Este é um recurso experimental e provavelmente terá bugs,
|
||||
então experimente e [abra todos os problemas][contribuir: enviando-problema]!
|
||||
|
||||
## Início rápido: Windows
|
||||
|
||||
Pré-requisitos:
|
||||
- Windows 7 ou mais recente
|
||||
- [Git][primeiros passos:git]
|
||||
- [Visual Studio] [primeiros passos: visual-studio] 2015 Update 3 ou superior com o pacote de idioma inglês
|
||||
|
||||
Primeiro, baixe e inicialize o próprio vcpkg; pode ser instalado em qualquer lugar,
|
||||
mas geralmente recomendamos usar vcpkg como um submódulo para projetos CMake,
|
||||
e instalá-lo globalmente para projetos do Visual Studio.
|
||||
Recomendamos algum lugar como `C:\src\vcpkg` ou `C:\dev\vcpkg`,
|
||||
caso contrário, você pode ter problemas de caminho para alguns sistemas de compilação de portas.
|
||||
|
||||
```cmd
|
||||
> git clone https://github.com/microsoft/vcpkg
|
||||
> .\vcpkg\bootstrap-vcpkg.bat
|
||||
```
|
||||
|
||||
Para instalar bibliotecas para os seus projectos, execute:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [nome do pacote por instalar]
|
||||
```
|
||||
|
||||
Nota: este comando irá instalar bibliotecas x86 por padrão. Para instalar x64, execute:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [nome do pacote por instalar]:x64-windows
|
||||
```
|
||||
|
||||
Ou
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [nome do pacote por instalar] --triplet=x64-windows
|
||||
```
|
||||
|
||||
Voce pode também procurar pela biblioteca que precisa com o subcomando `search`:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg search [termo de procura]
|
||||
```
|
||||
|
||||
Para usar o vcpkg com o Visual Studio,
|
||||
execute o seguinte comando (pode exigir autorização do administrador):
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg integrate install
|
||||
```
|
||||
|
||||
Depois disso, agora você pode criar um novo projeto sem CMake (ou abrir um já existente).
|
||||
Todas as bibliotecas instaladas estarão imediatamente prontas para serem `#include`'d e usadas
|
||||
em seu projeto sem configuração adicional.
|
||||
|
||||
Se você estiver usando o CMake com o Visual Studio,
|
||||
continue [aqui](#vcpkg-com-projectos-visual-studio-cmake).
|
||||
|
||||
Para usar vcpkg com CMake fora de um IDE,
|
||||
você pode usar o arquivo toolchain:
|
||||
|
||||
```cmd
|
||||
> cmake -B [diretorio de trabalho] -S . "-DCMAKE_TOOLCHAIN_FILE=[localizacao do vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
> cmake --build [diretorio de trabalho]
|
||||
```
|
||||
|
||||
Com o CMake, você ainda precisará de `find_package` (localizar os pacotes) e similares para usar as bibliotecas.
|
||||
Confira a [secção CMake](#usando-vcpkg-com-cmake) para mais informações,
|
||||
incluindo o uso do CMake com um IDE.
|
||||
|
||||
Para quaisquer outras ferramentas, incluindo o Visual Studio Code,
|
||||
confira o [guia de integração][primeiros passos: integração].
|
||||
|
||||
## Início rápido: Unix
|
||||
|
||||
Pré-requisitos para Linux:
|
||||
- [Git][primeiros passos:git]
|
||||
- [g++][primeiros passos:linux-gcc] >= 6
|
||||
|
||||
Pré-requisitos para macOS:
|
||||
- [Apple Developer Tools][primeiros passos: macos-dev-tools]
|
||||
|
||||
Primeiro, baixe e inicialize o próprio vcpkg; pode ser instalado em qualquer lugar,
|
||||
mas geralmente recomendamos o uso de vcpkg como um submódulo para projetos CMake.
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/microsoft/vcpkg
|
||||
$ ./vcpkg/bootstrap-vcpkg.sh
|
||||
```
|
||||
|
||||
Para instalar as bibliotecas do seu projecto, execute:
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg install [pacote por instalar]
|
||||
```
|
||||
|
||||
Voce pode também procurar pela biblioteca que precisa com o subcomando `search`:
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg search [termo de pesquisa]
|
||||
```
|
||||
|
||||
Para usar vcpkg com CMake, você pode usar o arquivo toolchain:
|
||||
|
||||
```sh
|
||||
$ cmake -B [diretorio de trabalho] -S . "-DCMAKE_TOOLCHAIN_FILE=[localizacao do vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
$ cmake --build [diretorio de trabalho]
|
||||
```
|
||||
|
||||
Com o CMake, você ainda precisará `find_package` e similares para usar as bibliotecas.
|
||||
Confira a [seção CMake](#using-vcpkg-with-cmake)
|
||||
para obter mais informações sobre a melhor forma de usar vcpkg com CMake,
|
||||
e ferramentas CMake para VSCode.
|
||||
|
||||
Para quaisquer outras ferramentas, confira o [guia de integração][primeiros passos:integração].
|
||||
|
||||
## Instalando ferramentas de desenvolvedor do Linux
|
||||
|
||||
Nas diferentes distros do Linux, existem diferentes pacotes que você
|
||||
precisa instalar:
|
||||
|
||||
- Debian, Ubuntu, popOS e outras distribuições baseadas em Debian:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
Para quaisquer outras distribuições, certifique-se de instalar o g++ 6 ou superior.
|
||||
Se você deseja adicionar instruções para sua distro específica, [abra um PR][contribuindo:enviar-pr]!
|
||||
|
||||
## Instalação das ferramentas de desenvolvedor do macOS
|
||||
|
||||
No macOS, a única coisa que você precisa fazer é executar o seguinte no seu terminal:
|
||||
|
||||
```sh
|
||||
$ xcode-select --install
|
||||
```
|
||||
|
||||
Em seguida, siga as instruções nas janelas que aparecerem.
|
||||
|
||||
Você poderá inicializar o vcpkg junto com o [guia de início rápido](#quick-start-unix)
|
||||
|
||||
## Usando vcpkg com CMake
|
||||
|
||||
### Visual Studio Code com ferramentas CMake
|
||||
|
||||
Adicionar o seguinte ao seu espaço de trabalho `settings.json` fará CMake Tools usar automaticamente `vcpkg` para bibliotecas:
|
||||
|
||||
```json
|
||||
{
|
||||
"cmake.configureSettings": {
|
||||
"CMAKE_TOOLCHAIN_FILE": "[vcpkg root]/scripts/buildsystems/vcpkg.cmake"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Vcpkg com Projetos CMake do Visual Studio
|
||||
|
||||
Abra o CMake Settings Editor e, em `CMake toolchain file`, adicione o caminho ao arquivo de cadeia de ferramentas vcpkg:
|
||||
|
||||
```
|
||||
[vcpkg root]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
### Vcpkg com CLion
|
||||
|
||||
Abra as configurações das cadeias de ferramentas
|
||||
(Arquivo > Configurações no Windows e Linux, CLion > Preferências no macOS), e vá para as configurações do CMake (Build, Execution, Deployment > CMake). Finalmente, em `CMake options`, adicione a seguinte linha:
|
||||
|
||||
```
|
||||
-DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
Você deve adicionar esta linha a cada perfil.
|
||||
|
||||
### Vcpkg como um submódulo
|
||||
|
||||
Ao usar o vcpkg como um submódulo do seu projeto,
|
||||
você pode adicionar o seguinte ao seu CMakeLists.txt antes da primeira chamada `project()`, em vez de passar `CMAKE_TOOLCHAIN_FILE` para a invocação do cmake.
|
||||
|
||||
```cmake
|
||||
set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "Vcpkg toolchain file")
|
||||
```
|
||||
|
||||
Isso ainda permitirá que as pessoas não usem o vcpkg, passando o `CMAKE_TOOLCHAIN_FILE` diretamente, mas tornará a etapa de configuração-construção um pouco mais fácil.
|
||||
|
||||
[getting-started:using-a-package]: https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages
|
||||
[getting-started:integration]: https://learn.microsoft.com/en-us/vcpkg/users/buildsystems/msbuild-integration
|
||||
[getting-started:git]: https://git-scm.com/downloads
|
||||
[getting-started:cmake-tools]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools
|
||||
[getting-started:linux-gcc]: #installing-linux-developer-tools
|
||||
[getting-started:macos-dev-tools]: #installing-macos-developer-tools
|
||||
[getting-started:macos-brew]: #installing-gcc-on-macos
|
||||
[getting-started:macos-gcc]: #installing-gcc-on-macos
|
||||
[getting-started:visual-studio]: https://visualstudio.microsoft.com/
|
||||
[getting-started:manifest-spec]: https://learn.microsoft.com/en-us/vcpkg/users/manifests
|
||||
|
||||
# Tab-Completion/Auto-Completion
|
||||
|
||||
`vcpkg` suporta preenchimento automático de comandos, nomes de pacotes, e opções em powershell e bash. Para habilitar o preenchimento de tabulação no shell de sua escolha, execute:
|
||||
|
||||
```pwsh
|
||||
> .\vcpkg integrate powershell
|
||||
```
|
||||
|
||||
Ou:
|
||||
|
||||
```sh
|
||||
$ ./vcpkg integrate bash # or zsh
|
||||
```
|
||||
|
||||
dependendo do shell que você usa, reinicie o console.
|
||||
|
||||
# Exemplos
|
||||
|
||||
Consulte a [documentação](https://learn.microsoft.com/vcpkg) para orientações específicas,
|
||||
incluindo [instalando e usando um pacote](https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages),
|
||||
[adicionando um novo pacote de um arquivo zip](https://learn.microsoft.com/vcpkg/examples/packaging-zipfiles),
|
||||
e [adicionando um novo pacote de um repositório GitHub](https://learn.microsoft.com/vcpkg/examples/packaging-github-repos).
|
||||
|
||||
Nossos documentos agora também estão disponíveis online em nosso site <https://vcpkg.io/>. Nós realmente apreciamos todo e qualquer feedback! Você pode enviar um problema em <https://github.com/vcpkg/vcpkg.github.io/issues>.
|
||||
|
||||
Veja um [vídeo de demonstração](https://www.youtube.com/watch?v=y41WFKbQFTw) de 4 minutos.
|
||||
|
||||
# Contribuindo
|
||||
|
||||
Vcpkg é um projeto de código aberto e, portanto, é construído com suas contribuições.
|
||||
Aqui estão algumas maneiras pelas quais você pode contribuir:
|
||||
|
||||
* [Enviar problemas][contributing:submit-issue] em vcpkg ou pacotes existentes
|
||||
* [Enviar correções e novos pacotes][contributing:submit-pr]
|
||||
|
||||
Consulte nosso [Guia de contribuição](CONTRIBUTING.md) para obter mais detalhes.
|
||||
|
||||
Este projeto adotou o [Código de Conduta de Código Aberto da Microsoft][contributing:coc].
|
||||
Para obter mais informações, consulte as [Perguntas frequentes sobre o Código de Conduta][contributing:coc-faq]
|
||||
ou e-mail [opencode@microsoft.com](mailto:opencode@microsoft.com)
|
||||
com quaisquer perguntas ou comentários adicionais.
|
||||
|
||||
[contribuindo:submit-issue]: https://github.com/microsoft/vcpkg/issues/new/choose
|
||||
[contribuindo:submit-pr]: https://github.com/microsoft/vcpkg/pulls
|
||||
[contribuindo:coc]: https://opensource.microsoft.com/codeofconduct/
|
||||
[contribuindo:coc-faq]: https://opensource.microsoft.com/codeofconduct/
|
||||
|
||||
# Segurança
|
||||
|
||||
A maioria das portas no vcpkg compila as bibliotecas em questão usando o sistema de compilação original preferido
|
||||
pelos desenvolvedores originais dessas bibliotecas e baixar o código-fonte e criar ferramentas de seus
|
||||
locais de distribuição oficiais. Para uso atrás de um firewall, o acesso específico necessário dependerá
|
||||
em quais portas estão sendo instaladas. Se você precisar instalar em um ambiente "air gap", considere
|
||||
instalando uma vez em um ambiente sem "air gap", preenchendo um
|
||||
[cache de ativos](https://learn.microsoft.com/vcpkg/users/assetcaching) compartilhado com o ambiente "air gapped".
|
||||
|
||||
# Telemetria
|
||||
|
||||
vcpkg coleta dados de uso para nos ajudar a melhorar sua experiência.
|
||||
Os dados coletados pela Microsoft são anônimos.
|
||||
Você pode cancelar a telemetria por
|
||||
- executando o script bootstrap-vcpkg com -disableMetrics
|
||||
- passando --disable-metrics para vcpkg na linha de comando
|
||||
- definir a variável de ambiente VCPKG_DISABLE_METRICS
|
||||
|
||||
Leia mais sobre a telemetria vcpkg em [https://learn.microsoft.com/vcpkg/about/privacy](https://learn.microsoft.com/vcpkg/about/privacy).
|
||||
330
README_vn.md
330
README_vn.md
@ -1,330 +0,0 @@
|
||||
# Vcpkg: Tổng quan
|
||||
|
||||
[English](README.md)
|
||||
[中文总览](README_zh_CN.md)
|
||||
[Español](README_es.md)
|
||||
[한국어](README_ko_KR.md)
|
||||
[Français](README_fr.md)
|
||||
|
||||
Vcpkg giúp bạn quản lý các thư viện C và C++ trên Windows, Linux và MacOS.
|
||||
Phần mềm này và hệ sinh thái của nó vẫn đang không ngừng phát triển, và chúng tôi luôn trân trọng những đóng góp của bạn!
|
||||
|
||||
Nếu bạn chưa từng sử dụng vcpkg trước đây, hoặc nếu bạn đang tìm hiểu cách để sử dụng vcpkg, xin hãy xem phần [Bắt Đầu](#bắt-đầu) cho hướng dẫn cài đặt vcpkg.
|
||||
|
||||
Để xem mô tả ngắn về những lệnh khả thi, khi bạn đã cài đặt vcpkg, bạn có thể chạy `vcpkg help`, hoặc `vcpkg help [command]` cho những lệnh nhất định.
|
||||
|
||||
* GitHub: Các port ở [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg), phần mềm ở [https://github.com/microsoft/vcpkg-tool](https://github.com/microsoft/vcpkg-tool)
|
||||
* Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/), kênh #vcpkg
|
||||
* Discord: [\#include \<C++\>](https://www.includecpp.org), kênh #🌏vcpkg
|
||||
* Docs: [Tài liệu](https://learn.microsoft.com/vcpkg)
|
||||
|
||||
# Mục Lục
|
||||
|
||||
- [Vcpkg: Tổng quan](#vcpkg-tổng-quan)
|
||||
- [Mục Lục](#mục-lục)
|
||||
- [Bắt Đầu](#bắt-đầu)
|
||||
- [Bắt Đầu Nhanh: Windows](#bắt-đầu-nhanh-windows)
|
||||
- [Bắt Đầu Nhanh: Unix](#bắt-đầu-nhanh-unix)
|
||||
- [Cài đặt Developer Tools cho Linux](#cài-đặt-developer-tools-cho-linux)
|
||||
- [Cài đặt Developer Tools cho macOS](#cài-đặt-developer-tools-cho-macos)
|
||||
- [Sử dụng vcpkg với CMake](#sử-dụng-vcpkg-với-cmake)
|
||||
- [Visual Studio Code với Công cụ CMake](#visual-studio-code-với-công-cụ-cmake)
|
||||
- [Vcpkg với Visual Studio CMake Projects](#vcpkg-với-visual-studio-cmake-projects)
|
||||
- [Vcpkg với CLion](#vcpkg-với-clion)
|
||||
- [Vcpkg dưới dạng Submodule](#vcpkg-dưới-dạng-submodule)
|
||||
- [Gợi ý/Tự động điền](#gợi-ýtự-động-điền)
|
||||
- [Các ví dụ](#các-ví-dụ)
|
||||
- [Đóng Góp](#đóng-góp)
|
||||
- [Giấy Phép](#giấy-phép)
|
||||
- [Bảo Mật](#bảo-mật)
|
||||
- [Thu Thập Dữ Liệu](#thu-thập-dữ-liệu)
|
||||
|
||||
# Bắt Đầu
|
||||
Đầu tiên, hãy làm theo hướng dẫn cài đặt cho [Windows](#bắt-đầu-nhanh-windows), hoặc [macOS và Linux](#bắt-đầu-nhanh-unix), tùy theo hệ điều hành mà bạn đang sử dụng.
|
||||
|
||||
Ngoài ra, hãy xem [Cài đặt và Sử dụng Packages][getting-started:using-a-package].
|
||||
Nếu một thư viện bạn cần hiện đang chưa có trong vcpkg, bạn có thể [mở một issue trên GitHub repo][contributing:submit-issue] nơi mà đội ngũ vcpkg và cộng đồng có thể thấy và có khả năng thêm port đó vào vcpkg.
|
||||
|
||||
Sau khi bạn đã cài đặt vcpkg, bạn có thể muốn thêm [tự động điền](#gợi-ýtự-động-điền) vào shell của bạn.
|
||||
|
||||
## Bắt Đầu Nhanh: Windows
|
||||
|
||||
Yêu cầu:
|
||||
- Windows 7 trở lên
|
||||
- [Git][getting-started:git]
|
||||
- [Visual Studio][getting-started:visual-studio] 2015 Update 3 trở lên với gói ngôn ngữ Tiếng Anh
|
||||
|
||||
Đầu tiên, tải và khởi động vcpkg; nó có thể được cài đặt bất kỳ đâu, nhưng
|
||||
chúng tôi khuyến cáo sử dụng vcpkg như một submoudle cho các project CMake,
|
||||
và cài đặt nó toàn máy cho các project Visual Studio.
|
||||
Chúng tôi gợi ý cài ở những nơi như `C:\src\vcpkg` hoặc `C:\dev\vcpkg`,
|
||||
bởi vì nếu cài những nơi khác bạn có thể gặp các lỗi đường dẫn đối với
|
||||
hệ thống build của một vài port.
|
||||
|
||||
```cmd
|
||||
> git clone https://github.com/microsoft/vcpkg
|
||||
> .\vcpkg\bootstrap-vcpkg.bat
|
||||
```
|
||||
|
||||
Để cài đặt các thư viện cho project của bạn, hãy chạy:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [packages to install]
|
||||
```
|
||||
|
||||
Lưu ý: Lệnh này sẽ mặc định cài đặt phiên bản x86 của thư viện, để cài x64 hãy chạy:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [package name]:x64-windows
|
||||
```
|
||||
|
||||
Hoặc
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [packages to install] --triplet=x64-windows
|
||||
```
|
||||
|
||||
Bạn cũng có thể tìm kiếm các thư viện bạn cần với lệnh `search`:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg search [search term]
|
||||
```
|
||||
|
||||
Để sử dụng vcpkg với Visual Studio,
|
||||
hãy chạy lệnh sau (có thể yêu cầu quyền administrator):
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg integrate install
|
||||
```
|
||||
|
||||
Sau khi xong, bạn có thể tạo một project mới (trừ CMake), hoặc mở một project có sẵn.
|
||||
Tất cả các thư viện sẽ ngay lập tức có sẵn để được `#include` và sử dụng
|
||||
trong project của bạn mà không cần cấu hình gì thêm.
|
||||
|
||||
Nếu bạn đang sử dụng CMake với Visual Studio,
|
||||
hãy tiếp tục [ở đây](#vcpkg-với-visual-studio-cmake-projects).
|
||||
|
||||
Để sử dụng vcpkg với CMake bên ngoài một IDE,
|
||||
bạn có thể sử dụng file toolchain:
|
||||
|
||||
```cmd
|
||||
> cmake -B [build directory] -S . "-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
> cmake --build [build directory]
|
||||
```
|
||||
|
||||
Với CMake, bạn vẫn sẽ cần thêm `find_package` và những lệnh khác để sử dụng thư viện.
|
||||
Hãy xem [phần CMake](#sử-dụng-vcpkg-với-cmake) để biết thêm,
|
||||
bao gồm việc sử dụng CMake với một IDE.
|
||||
|
||||
## Bắt Đầu Nhanh: Unix
|
||||
|
||||
Yêu cầu cho Linux:
|
||||
- [Git][getting-started:git]
|
||||
- [g++][getting-started:linux-gcc] >= 6
|
||||
|
||||
Yêu cầu cho macOS:
|
||||
- [Apple Developer Tools][getting-started:macos-dev-tools]
|
||||
|
||||
Đầu tiên, tải và khởi động vcpkg; nó có thể được cài đặt bất kỳ đâu, nhưng
|
||||
chúng tôi khuyến cáo sử dụng vcpkg như một submoudle cho các project CMake.
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/microsoft/vcpkg
|
||||
$ ./vcpkg/bootstrap-vcpkg.sh
|
||||
```
|
||||
|
||||
Để cài đặt các thư viện cho project của bạn, hãy chạy:
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg install [packages to install]
|
||||
```
|
||||
|
||||
Bạn cũng có thể tìm kiếm các thư viện bạn cần với lệnh `search`:
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg search [search term]
|
||||
```
|
||||
|
||||
Để sử dụng vcpkg với CMake, bạn có thể sử dụng file toolchain:
|
||||
|
||||
```sh
|
||||
$ cmake -B [build directory] -S . "-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
$ cmake --build [build directory]
|
||||
```
|
||||
|
||||
Với CMake, bạn vẫn sẽ cần thêm `find_package` và những lệnh khác để sử dụng thư viện.
|
||||
Hãy xem [phần CMake](#sử-dụng-vcpkg-với-cmake) để biết thêm
|
||||
về các tốt nhất để sử dụng vcpkg với CMake,
|
||||
và Công cụ CMake cho VSCode.
|
||||
|
||||
## Cài đặt Developer Tools cho Linux
|
||||
|
||||
Dưới nhiều phiên bản Linux, có các package sau đây bạn sẽ cần phải cài đặt:
|
||||
|
||||
- Debian, Ubuntu, popOS, và các phiên bản khác dựa trên Debian:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
Cho bất kỳ phiên bản nào khác, hãy chắc chắn rằng bạn cài đặt g++ 6 trở lên.
|
||||
Nếu bạn muốn thêm hướng dẫn cho phiên bản của bạn,
|
||||
[xin hãy mở một PR][contributing:submit-pr]!
|
||||
|
||||
## Cài đặt Developer Tools cho macOS
|
||||
|
||||
Trên macOS, thứ duy nhất bạn cần làm là chạy lệnh sau đây trong terminal:
|
||||
|
||||
```sh
|
||||
$ xcode-select --install
|
||||
```
|
||||
|
||||
Sau đó làm theo hướng dẫn trong cửa sổ được mở ra.
|
||||
|
||||
Sau đó bạn sẽ có thể khởi động vcpkg theo hướng dẫn ở [bắt đầu nhanh](#bắt-đầu-nhanh-unix)
|
||||
|
||||
## Sử dụng vcpkg với CMake
|
||||
|
||||
### Visual Studio Code với Công cụ CMake
|
||||
|
||||
Thêm phần sau đây vào file `settings.json` trong workspace của bạn
|
||||
sẽ làm cho Công cụ CMake tự động sử dụng vcpkg cho các thư viện
|
||||
của bạn:
|
||||
|
||||
```json
|
||||
{
|
||||
"cmake.configureSettings": {
|
||||
"CMAKE_TOOLCHAIN_FILE": "[vcpkg root]/scripts/buildsystems/vcpkg.cmake"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Vcpkg với Visual Studio CMake Projects
|
||||
|
||||
Mở CMake Settings Editor, dưới phần `CMake toolchain file`,
|
||||
thêm đường dẫn tới file vcpkg toolchain:
|
||||
|
||||
```
|
||||
[vcpkg root]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
### Vcpkg với CLion
|
||||
|
||||
Mở Toolchains settings
|
||||
(File > Settings on Windows and Linux, CLion > Preferences on macOS),
|
||||
và đi tới phần CMake settings (Build, Execution, Deployment > CMake).
|
||||
Sau đó, trong `CMake options`, thên dòng sau đây:
|
||||
|
||||
```
|
||||
-DCMAKE_TOOLCHAIN_FILE=[vcpkg root]/scripts/buildsystems/vcpkg.cmake
|
||||
```
|
||||
|
||||
Bạn phải thêm dòng này vào mỗi profile khác nhau.
|
||||
|
||||
### Vcpkg dưới dạng Submodule
|
||||
|
||||
Khi sử dụng vcpkg như một submodule cho project của bạn,
|
||||
bạn có thể thêm dòng sau đây vào file CMakeLists.txt trước dòng `project()` đầu tiên,
|
||||
thay vì phải sự dụng lệnh `CMAKE_TOOLCHAIN_FILE`.
|
||||
|
||||
```cmake
|
||||
set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "Vcpkg toolchain file")
|
||||
```
|
||||
|
||||
Cách này vẫn hỗ trợ những người không dùng vcpkg,
|
||||
bằng cách trực tiếp thêm `CMAKE_TOOLCHAIN_FILE`,
|
||||
nhưng nó sẽ khiến việc cấu hình-build trở nên dễ dàng hơn.
|
||||
|
||||
[getting-started:using-a-package]: https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages
|
||||
[getting-started:git]: https://git-scm.com/downloads
|
||||
[getting-started:cmake-tools]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools
|
||||
[getting-started:linux-gcc]: #cài-đặt-developer-tools-cho-linux
|
||||
[getting-started:macos-dev-tools]: #cài-đặt-developer-tools-cho-macos
|
||||
[getting-started:macos-brew]: #installing-gcc-on-macos
|
||||
[getting-started:macos-gcc]: #installing-gcc-on-macos
|
||||
[getting-started:visual-studio]: https://visualstudio.microsoft.com/
|
||||
|
||||
# Gợi ý/Tự động điền
|
||||
|
||||
`vcpkg` hỗ trợ tự động điền các lệnh, tên package, và các
|
||||
cài đặt trong lẫn powershell và bash.
|
||||
Để bật tự động điền trong shell của bạn, hãy chạy:
|
||||
|
||||
```pwsh
|
||||
> .\vcpkg integrate powershell
|
||||
```
|
||||
|
||||
Hoặc
|
||||
|
||||
```sh
|
||||
$ ./vcpkg integrate bash # or zsh
|
||||
```
|
||||
|
||||
tùy theo shell mà bạn sử dụng, rồi khởi động lại console.
|
||||
|
||||
# Các ví dụ
|
||||
|
||||
Hãy xem [tài liệu](https://learn.microsoft.com/vcpkg) cho các hướng dẫn chi tiết,
|
||||
bao gồm [cài đặt và sử dụng một package](https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages),
|
||||
[thêm package mới từ file zip](https://learn.microsoft.com/vcpkg/examples/packaging-zipfiles),
|
||||
và [thêm package mới từ GitHub repo](https://learn.microsoft.com/vcpkg/examples/packaging-github-repos).
|
||||
|
||||
Tài liệu của chúng tôi hiện đang có sẵn tại website https://vcpkg.io/. Chúng tôi rất trân trọng
|
||||
bất kỳ phản hồi nào của các bạn! Bạn có thể tạo một issue trong https://github.com/vcpkg/vcpkg.github.io/issues.
|
||||
|
||||
Xem [video demo](https://www.youtube.com/watch?v=y41WFKbQFTw) dài 4 phút.
|
||||
|
||||
# Đóng Góp
|
||||
|
||||
Vcpkg là một dự án mã nguồn mở, và được xây dụng từ sự đóng góp của các bạn.
|
||||
Sau đây là các cách mà bạn có thể đóng góp:
|
||||
|
||||
* [Tạo Issues][contributing:submit-issue] về vcpkg hoặc các package.
|
||||
* [Sửa lỗi và Thêm các package mới][contributing:submit-pr]
|
||||
|
||||
Xin hãy xem chi tiết trong [Hướng dẫn Đóng góp](CONTRIBUTING.md).
|
||||
|
||||
Dự án này áp dụng [Bộ Quy tắc Ứng xử Mã Nguồn Mở của Microsoft][contributing:coc].
|
||||
Các thông tin thêm, hãy xem [Quy tắc Ứng xử FAQ][contributing:coc-faq]
|
||||
hoặc gửi mail cho chúng tôi tại [opencode@microsoft.com](mailto:opencode@microsoft.com)
|
||||
với các câu hỏi hoặc bình luận.
|
||||
|
||||
[contributing:submit-issue]: https://github.com/microsoft/vcpkg/issues/new/choose
|
||||
[contributing:submit-pr]: https://github.com/microsoft/vcpkg/pulls
|
||||
[contributing:coc]: https://opensource.microsoft.com/codeofconduct/
|
||||
[contributing:coc-faq]: https://opensource.microsoft.com/codeofconduct/
|
||||
|
||||
# Giấy Phép
|
||||
|
||||
Mã nguồn trong repository này được cấp phép theo [Giấy phép MIT](LICENSE.txt). Các thư viện
|
||||
cung cấp bởi các port được cấp phép theo các điều khoản của tác giả gốc. Khi khả thi, vcpkg
|
||||
đặt (các) giấy phép liên quan tại `installed/<triplet>/share/<port>/copyright`.
|
||||
|
||||
# Bảo Mật
|
||||
|
||||
Hầu hết các port đều build các thư viện liên quan sử dụng các hệ thống build gốc được khuyến cáo
|
||||
bởi tác giả gốc của các thư viện đó, và tải mã nguồn và công cụ build từ nguồn chính thức của họ.
|
||||
Để sử dụng dưới tường lửa, các quyền truy cập nhất định sẽ dựa vào port nào đang được cài đặt.
|
||||
Nếu bạn buộc phải cài đặt trong một môi trường "cách ly không khí", xin hãy cân nhắc việc cài đặt
|
||||
một lần trong môi trường không "cách ly không khí", để tạo [asset cache](https://learn.microsoft.com/vcpkg/users/assetcaching) được chia sẻ với môi trường "cách ly không khí" kia.
|
||||
|
||||
# Thu Thập Dữ Liệu
|
||||
|
||||
vcpkg thu thập dữ liệu trong lúc sử dụng để giúp chúng tôi cải thiện trải nghiệm của bạn.
|
||||
Dữ liệu thu thập được bởi Microsoft là ẩn danh.
|
||||
Bạn có thể tùy chọn không thu thập dữ liệu bằng cách
|
||||
- chạy bootstrap-vcpkg với lệnh -disableMetrics
|
||||
- chạy vcpkg với lệnh --disable-metrics
|
||||
- thêm VCPKG_DISABLE_METRICS vào biến môi trường
|
||||
|
||||
Đọc thêm về việc thu thập dữ liệu của vcpkg tại [https://learn.microsoft.com/vcpkg/about/privacy](https://learn.microsoft.com/vcpkg/about/privacy).
|
||||
305
README_zh_CN.md
305
README_zh_CN.md
@ -1,305 +0,0 @@
|
||||
# Vcpkg: 总览
|
||||
|
||||
[English Overview](README.md)
|
||||
|
||||
Vcpkg 可帮助您在 Windows、 Linux 和 MacOS 上管理 C 和 C++ 库。
|
||||
这个工具和生态链正在不断发展，我们一直期待您的贡献！
|
||||
|
||||
若您从未使用过 vcpkg，或者您正在尝试了解如何使用 vcpkg，请查阅 [入门](#入门) 章节。
|
||||
|
||||
如需获取有关可用命令的简短描述，请在编译 vcpkg 后执行 `vcpkg help` 或执行 `vcpkg help [command]` 来获取具体的帮助信息。
|
||||
|
||||
* GitHub: 端口位于 [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg)，程序位于 [https://github.com/microsoft/vcpkg-tool](https://github.com/microsoft/vcpkg-tool)
|
||||
* Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/)， #vcpkg 频道
|
||||
* Discord: [\#include \<C++\>](https://www.includecpp.org)， #🌏vcpkg 频道
|
||||
* 文档: [Documentation](https://learn.microsoft.com/vcpkg)
|
||||
|
||||
# 目录
|
||||
|
||||
- [Vcpkg: 总览](#vcpkg-总览)
|
||||
- [目录](#目录)
|
||||
- [入门](#入门)
|
||||
- [快速开始: Windows](#快速开始-windows)
|
||||
- [快速开始: Unix](#快速开始-unix)
|
||||
- [安装 Linux Developer Tools](#安装-linux-developer-tools)
|
||||
- [安装 macOS Developer Tools](#安装-macos-developer-tools)
|
||||
- [在 CMake 中使用 vcpkg](#在-cmake-中使用-vcpkg)
|
||||
- [Visual Studio Code 中的 CMake Tools](#visual-studio-code-中的-cmake-tools)
|
||||
- [Visual Studio CMake 工程中使用 vcpkg](#visual-studio-cmake-工程中使用-vcpkg)
|
||||
- [CLion 中使用 vcpkg](#clion-中使用-vcpkg)
|
||||
- [将 vcpkg 作为一个子模块](#将-vcpkg-作为一个子模块)
|
||||
- [Tab补全/自动补全](#tab-补全自动补全)
|
||||
- [示例](#示例)
|
||||
- [贡献](#贡献)
|
||||
- [开源协议](#开源协议)
|
||||
- [安全事项](#安全事项)
|
||||
- [数据收集](#数据收集)
|
||||
|
||||
# 入门
|
||||
|
||||
首先，请阅读以下任一快速入门指南：
|
||||
[Windows](#快速开始-windows) 或 [macOS 和 Linux](#快速开始-unix)，
|
||||
这取决于您使用的是什么平台。
|
||||
|
||||
更多有关信息，请参见 [安装和使用软件包][getting-started:using-a-package]。
|
||||
如果 vcpkg 目录中没有您需要的库，
|
||||
您可以 [在 GitHub 上打开问题][contributing:submit-issue]。
|
||||
vcpkg 团队和贡献者可以在这里看到它，
|
||||
并可能将这个库添加到 vcpkg。
|
||||
|
||||
安装并运行 vcpkg 后，
|
||||
您可能希望将 [TAB 补全](#tab-补全自动补全) 添加到您的 Shell 中。
|
||||
|
||||
## 快速开始: Windows
|
||||
|
||||
前置条件:
|
||||
- Windows 7 或更新的版本
|
||||
- [Git][getting-started:git]
|
||||
- [Visual Studio][getting-started:visual-studio] 2015 Update 3 或更新的版本（**包含英文语言包**）
|
||||
|
||||
首先，**请使用 `git clone vcpkg`** 并执行 bootstrap.bat 脚本。
|
||||
您可以将 vcpkg 安装在任何地方，但是通常我们建议您使用 vcpkg 作为 CMake 项目的子模块，并将其全局安装到 Visual Studio 项目中。
|
||||
我们建议您使用例如 `C:\src\vcpkg` 或 `C:\dev\vcpkg` 的安装目录，否则您可能遇到某些库构建系统的路径问题。
|
||||
|
||||
```cmd
|
||||
> git clone https://github.com/microsoft/vcpkg
|
||||
> .\vcpkg\bootstrap-vcpkg.bat
|
||||
```
|
||||
|
||||
使用以下命令安装您的项目所需要的库：
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [packages to install]
|
||||
```
|
||||
|
||||
请注意: vcpkg 在 Windows 中默认编译并安装 x86 版本的库。 若要编译并安装 x64 版本，请执行:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [package name]:x64-windows
|
||||
```
|
||||
|
||||
或
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg install [packages to install] --triplet=x64-windows
|
||||
```
|
||||
|
||||
您也可以使用 `search` 子命令来查找 vcpkg 中集成的库:
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg search [search term]
|
||||
```
|
||||
|
||||
若您希望在 Visual Studio 中使用 vcpkg，请运行以下命令 (可能需要管理员权限)
|
||||
|
||||
```cmd
|
||||
> .\vcpkg\vcpkg integrate install
|
||||
```
|
||||
|
||||
在此之后，您可以创建一个非 CMake 项目 (或打开已有的项目)。
|
||||
在您的项目中，所有已安装的库均可立即使用 `#include` 包含您需使用的库的头文件且无需额外配置。
|
||||
|
||||
若您在 Visual Studio 中使用 CMake 工程，请查阅[这里](#visual-studio-cmake-工程中使用-vcpkg)。
|
||||
|
||||
为了在 IDE 以外在 CMake 中使用 vcpkg，您需要使用以下工具链文件:
|
||||
|
||||
```cmd
|
||||
> cmake -B [build directory] -S . "-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
> cmake --build [build directory]
|
||||
```
|
||||
|
||||
在 CMake 中，您仍需通过 `find_package` 来使用 vcpkg 中已安装的库。
|
||||
请查阅 [CMake 章节](#在-cmake-中使用-vcpkg) 获取更多信息，其中包含了在 IDE 中使用 CMake 的内容。
|
||||
|
||||
## 快速开始: Unix
|
||||
|
||||
Linux平台前置条件:
|
||||
- [Git][getting-started:git]
|
||||
- [g++][getting-started:linux-gcc] >= 6
|
||||
|
||||
macOS 平台前置条件:
|
||||
- [Apple Developer Tools][getting-started:macos-dev-tools]
|
||||
|
||||
首先，请下载 vcpkg 并执行 bootstrap.sh 脚本。
|
||||
您可以将 vcpkg 安装在任何地方，但是通常我们建议您使用 vcpkg 作为 CMake 项目的子模块。
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/microsoft/vcpkg
|
||||
$ ./vcpkg/bootstrap-vcpkg.sh
|
||||
```
|
||||
|
||||
使用以下命令安装任意包：
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg install [packages to install]
|
||||
```
|
||||
|
||||
您也可以使用 `search` 子命令来查找 vcpkg 中已集成的库:
|
||||
|
||||
```sh
|
||||
$ ./vcpkg/vcpkg search [search term]
|
||||
```
|
||||
|
||||
为了在 CMake 中使用 vcpkg，您需要使用以下工具链文件:
|
||||
|
||||
```sh
|
||||
$ cmake -B [build directory] -S . "-DCMAKE_TOOLCHAIN_FILE=[path to vcpkg]/scripts/buildsystems/vcpkg.cmake"
|
||||
$ cmake --build [build directory]
|
||||
```
|
||||
|
||||
在 CMake 中，您仍需通过 `find_package` 来使用 vcpkg 中已安装的库。
|
||||
为了您更好的在 CMake 或 VSCode CMake Tools 中使用 vcpkg，
|
||||
请查阅 [CMake 章节](#在-cmake-中使用-vcpkg) 获取更多信息，
|
||||
其中包含了在 IDE 中使用 CMake 的内容。
|
||||
|
||||
对于其他工具，请查阅 [集成指南][getting-started:integration]。
|
||||
|
||||
## 安装 Linux Developer Tools
|
||||
|
||||
在 Linux 的不同发行版中，您需要安装不同的工具包:
|
||||
|
||||
- Debian，Ubuntu，popOS 或其他基于 Debian 的发行版:
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
对于其他的发行版，请确保已安装 g++ 6 或更新的版本。
|
||||
若您希望添加特定发行版的说明，[请提交一个 PR][contributing:submit-pr]!
|
||||
|
||||
## 安装 macOS Developer Tools
|
||||
|
||||
在 macOS 中，您唯一需要做的是在终端中运行以下命令:
|
||||
|
||||
```sh
|
||||
$ xcode-select --install
|
||||
```
|
||||
|
||||
然后按照出现的窗口中的提示进行操作。
|
||||
此时，您就可以使用 bootstrap.sh 编译 vcpkg 了。 请参阅 [快速开始](#快速开始-unix)
|
||||
|
||||
## 在 CMake 中使用 vcpkg
|
||||
|
||||
### Visual Studio Code 中的 CMake Tools
|
||||
|
||||
将以下内容添加到您的工作区的 `settings.json` 中将使 CMake Tools 自动使用 vcpkg 中的第三方库:
|
||||
|
||||
```json
|
||||
{
|
||||
"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
|
||||
|
||||
Vcpkg 已经集成在 CLion IDE 中。具体操作请参见[官方文档](https://www.jetbrains.com/help/clion/package-management.html)。
|
||||
|
||||
### 将 vcpkg 作为一个子模块
|
||||
|
||||
当您希望将 vcpkg 作为一个子模块加入到您的工程中时，
|
||||
您可以在第一个 `project()` 调用之前将以下内容添加到 CMakeLists.txt 中，
|
||||
而无需将 `CMAKE_TOOLCHAIN_FILE` 传递给 CMake 调用。
|
||||
|
||||
```cmake
|
||||
set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake"
|
||||
CACHE STRING "Vcpkg toolchain file")
|
||||
```
|
||||
|
||||
使用此种方式可无需设置 `CMAKE_TOOLCHAIN_FILE` 即可使用 vcpkg，且更容易完成配置工作。
|
||||
|
||||
[getting-started:using-a-package]: https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages
|
||||
[getting-started:git]: https://git-scm.com/downloads
|
||||
[getting-started:cmake-tools]: https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools
|
||||
[getting-started:linux-gcc]: #installing-linux-developer-tools
|
||||
[getting-started:macos-dev-tools]: #installing-macos-developer-tools
|
||||
[getting-started:macos-brew]: #installing-gcc-on-macos
|
||||
[getting-started:macos-gcc]: #installing-gcc-on-macos
|
||||
[getting-started:visual-studio]: https://visualstudio.microsoft.com/
|
||||
|
||||
# Tab 补全/自动补全
|
||||
|
||||
`vcpkg` 支持在 Powershell 和 Bash 中自动补全命令，包名称及选项。
|
||||
若您需要在指定的 shell 中启用 Tab 补全功能，请依据您使用的 shell 运行：
|
||||
|
||||
```pwsh
|
||||
> .\vcpkg integrate powershell
|
||||
```
|
||||
|
||||
或
|
||||
|
||||
```sh
|
||||
$ ./vcpkg integrate bash # 或 zsh
|
||||
```
|
||||
|
||||
然后重新启动控制台。
|
||||
|
||||
# 示例
|
||||
|
||||
请查看 [文档](https://learn.microsoft.com/vcpkg) 获取具体示例，
|
||||
其包含 [安装并使用包](https://learn.microsoft.com/vcpkg/examples/installing-and-using-packages)，
|
||||
[使用压缩文件添加包](https://learn.microsoft.com/vcpkg/examples/packaging-zipfiles)
|
||||
和 [从 GitHub 源中添加一个包](https://learn.microsoft.com/vcpkg/examples/packaging-github-repos)。
|
||||
|
||||
我们的文档现在也可以从 [vcpkg.io](https://vcpkg.io/) 在线获取。
|
||||
我们真诚的希望您向我们提出关于此网站的任何建议! 请在[这里](https://github.com/vcpkg/vcpkg.github.io/issues) 创建 issue.
|
||||
|
||||
观看 4 分钟 [demo 视频](https://www.youtube.com/watch?v=y41WFKbQFTw)。
|
||||
|
||||
# 贡献
|
||||
|
||||
Vcpkg是一个开源项目，并通过您的贡献不断发展。
|
||||
下面是一些您可以贡献的方式:
|
||||
|
||||
* [提交一个关于 vcpkg 或已支持包的新 issue][contributing:submit-issue]
|
||||
* [提交修复 PR 和创建新包][contributing:submit-pr]
|
||||
|
||||
请参阅我们的 [贡献准则](CONTRIBUTING_zh.md) 了解更多详细信息。
|
||||
|
||||
该项目采用了 [Microsoft 开源行为准则][contributing:coc]。
|
||||
获取更多信息请查看 [行为准则 FAQ][contributing:coc-faq] 或联系 [opencode@microsoft.com](mailto:opencode@microsoft.com) 提出其他问题或意见。
|
||||
|
||||
[contributing:submit-issue]: https://github.com/microsoft/vcpkg/issues/new/choose
|
||||
[contributing:submit-pr]: https://github.com/microsoft/vcpkg/pulls
|
||||
[contributing:coc]: https://opensource.microsoft.com/codeofconduct/
|
||||
[contributing:coc-faq]: https://opensource.microsoft.com/codeofconduct/
|
||||
|
||||
# 开源协议
|
||||
|
||||
在此存储库中使用的代码均遵循 [MIT License](LICENSE.txt)。这些库是根据其作者的开源协议受到许可的。
|
||||
vcpkg会将库的协议文件放置在 `installed/<triplet>/share/<port>/copyright` 中。
|
||||
|
||||
# 安全事项
|
||||
|
||||
大多数vcpkg中的库采用其官方发布的构建工具来构建它们，并从其官方渠道下载源码及构建工具。
|
||||
若您的环境包含防火墙或反病毒程序，为了避免构建失败，请考虑在禁用防火墙与反病毒程序的环境中构建它们一次，
|
||||
再将它们生成的[二进制缓存](https://learn.microsoft.com/vcpkg/users/assetcaching)共享给原始环境中使用。
|
||||
|
||||
# 数据收集
|
||||
|
||||
vcpkg 会收集使用情况数据，以帮助我们改善您的体验。
|
||||
Microsoft 收集的数据是匿名的。
|
||||
您也可以通过以下步骤禁用数据收集：
|
||||
- 将选项 `-disableMetrics` 传递给 bootstrap-vcpkg 脚本并重新运行此脚本
|
||||
- 向 vcpkg 命令传递选项 `--disable-metrics`
|
||||
- 设置环境变量 `VCPKG_DISABLE_METRICS`
|
||||
|
||||
请在 [https://learn.microsoft.com/vcpkg/about/privacy](https://learn.microsoft.com/vcpkg/about/privacy) 中了解有关 vcpkg 数据收集的更多信息。
|
||||
Loading…
Reference in New Issue
Block a user