mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-11-25 10:09:06 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
C++ Library Manager for Windows, Linux, and MacOS
6,186 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%
a59307436e
Go to file
Alexander Karatarakis a59307436e
Merge pull request #3392 from agruzdev/dev/agruzdev/yato 
[yato] Bugfix
2018-04-30 13:44:29 -07:00
docs Add crossplatform announcement to docs 2018-04-24 18:52:32 -04:00
ports Merge remote-tracking branch 'remotes/origin/master' into dev/agruzdev/yato 2018-04-30 19:31:00 +01:00
scripts [Clean patching] Each portref-patchset combo gets its own hash-based directory 2018-04-27 22:52:55 -07:00
toolsrc [vcpkg-integrate-install] Add vcpkg.path.txt to localappdata for more generic consumption. 2018-04-28 14:17:52 -07: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 Update gitignore to exclude the vcpkg binary (artifact of the build 2018-04-25 12:04:58 -04:00
.vcpkg-root Add .vcpkg-root file that signifies the root directory 2016-09-19 18:49:38 -07:00
bootstrap-vcpkg.bat Fix bootstrap-vcpkg.bat to work with space in path 2017-04-17 12:15:07 -07:00
bootstrap-vcpkg.sh [sh] Tweak so only the sh forwarder needs to be +x 2018-04-26 02:11:04 +00:00
CHANGELOG.md Update CHANGELOG and bump version to v0.0.110 2018-04-24 10:42:38 -07: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 Update Readme to reflect cross-platform support (#3304) 2018-04-25 17:58:32 -07:00

README.md

Vcpkg

Overview

Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This tool and ecosystem are currently in a preview state; 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.10.2

To get started:

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

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

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

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

Install any packages with

PS> .\vcpkg install sdl2 curl
Ubuntu:~/$ ./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. To enable tab-completion in Powershell, use

.\vcpkg integrate powershell

and restart Powershell.

Examples

See the documentation for specific walkthroughs, including using a package and adding a new package.

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.