mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-11-30 17:39:11 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
C++ Library Manager for Windows, Linux, and MacOS
7,742 Commits 1 Branch 58 Tags 412 MiB
CMake 72.9%
PowerShell 19.9%
Shell 3.5%
Python 2.6%
C++ 0.5%
Other 0.5%
4c2bc1f074
Go to file
Thomas Arcila 4c2bc1f074 Fix tools/ and add support vcpkg_test_cmake()
2019-03-11 04:32:25 -04:00
docs [vcpkg-docs] Replace reference to VCPKG_DEFAULT_VS_PATH with VCPKG_VISUAL_STUDIO_PATH 2019-02-25 13:25:27 -08:00
ports Fix tools/ and add support vcpkg_test_cmake() 2019-03-11 04:32:25 -04:00
scripts Add DPDK package (#5388) 2019-03-06 23:37:24 -08:00
toolsrc [vcpkg edit] Update find_from_registry (#5393) 2019-03-08 14:38:23 -08:00
triplets Add triplets for x64-linux and x64-osx 2018-04-23 19:33:19 -07:00
.gitattributes [everything] Use -text to ensure consistent files across machines. 2018-02-26 18:18:05 -08:00
.gitignore Modify vcpkg_fixup_cmake_targets() (#5459) 2019-02-28 23:53:42 -08:00
.vcpkg-root Add .vcpkg-root file that signifies the root directory 2016-09-19 18:49:38 -07:00
bootstrap-vcpkg.bat bootstrap.bat now forwards args to ps1 2018-06-08 16:26:57 -07:00
bootstrap-vcpkg.sh [bootstrap.sh] Fix whitespace-in-path issues 2018-05-16 04:51:08 +00:00
CHANGELOG.md Update CHANGELOG and bump version to 2018.11.23 2018-11-23 14:18:46 -08:00
CONTRIBUTING.md Moved CONTRIBUTING.md to root. Fixes #54. 2016-09-21 13:35:51 -07:00
LICENSE.txt Initial commit 2016-09-18 20:54:03 -07:00
README.md [autocomplete] Add tab-completion support for bash 2018-12-13 14:02:02 -08:00

README.md

Vcpkg

Overview

Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This tool and ecosystem are constantly evolving; your involvement is vital to its success!

For short description of available commands, run vcpkg help.

Quick Start

Prerequisites:

  • Windows 10, 8.1, 7, Linux, or MacOS
  • Visual Studio 2017 or Visual Studio 2015 Update 3 (on Windows)
  • Git
  • Optional: CMake 3.12.4

To get started:

> git clone https://github.com/Microsoft/vcpkg.git
> cd vcpkg

PS> .\bootstrap-vcpkg.bat
Linux:~/$ ./bootstrap-vcpkg.sh

Then, to hook up user-wide integration, run (note: requires admin on first use)

PS> .\vcpkg integrate install
Linux:~/$ ./vcpkg integrate install

Install any packages with

PS> .\vcpkg install sdl2 curl
Linux:~/$ ./vcpkg install sdl2 curl

The best way to use installed libraries with CMake is via the toolchain file scripts\buildsystems\vcpkg.cmake. To use this file, you simply need to add it onto your CMake command line as -DCMAKE_TOOLCHAIN_FILE=[vcpkg root]\scripts\buildsystems\vcpkg.cmake.

In Visual Studio, you can create a New Project (or open an existing one). All installed libraries are immediately ready to be #include'd and used in your project without additional configuration.

For more information, see our using a package example for the specifics.

Additional notes on macOS and Linux support can be found in the official announcement.

Tab-Completion / Auto-Completion

vcpkg supports auto-completion of commands, package names, options etc in Powershell and bash. To enable tab-completion, use one of the following:

PS> .\vcpkg integrate powershell
Linux:~/$ ./vcpkg integrate bash

and restart your console.

Examples

See the documentation for specific walkthroughs, including installing and using a package, adding a new package from a zipfile, and adding a new package from a GitHub repo.

Our docs are now also available online at ReadTheDocs: https://vcpkg.readthedocs.io/!

See a 4 minute video demo.

Contributing

Vcpkg is built with your contributions. Here are some ways you can contribute:

Please refer to our Contribution guidelines for more details.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

License

Code licensed under the MIT License.