# Vcpkg ![](https://devdiv.visualstudio.com/_apis/public/build/definitions/0bdbc590-a062-4c3f-b0f6-9383f67865ee/5261/badge) ## Overview Vcpkg helps you get C and C++ libraries on Windows. 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, or 7 - Visual Studio 2017 or Visual Studio 2015 Update 3 - Git - *Optional: CMake 3.10.2* Clone this repository, then run ``` C:\src\vcpkg> .\bootstrap-vcpkg.bat ``` Then, to hook up user-wide integration, run (note: requires admin on first use) ``` C:\src\vcpkg> .\vcpkg integrate install ``` Install any packages with ``` C:\src\vcpkg> .\vcpkg install sdl2 curl ``` Finally, create a New Project (or open an existing one) in Visual Studio 2017 or 2015. All installed libraries are immediately ready to be `#include`'d and used in your project. For CMake projects, simply include our toolchain file. See our [using a package](docs/examples/using-sqlite.md) example for the specifics. ## 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](docs/index.md) for specific walkthroughs, including [using a package](docs/examples/using-sqlite.md) and [adding a new package](docs/examples/packaging-zlib.md). Our docs are now also available online at ReadTheDocs: ! See a 4 minute [video demo](https://www.youtube.com/watch?v=y41WFKbQFTw). ## Contributing Vcpkg is built with your contributions. Here are some ways you can contribute: * [Submit Issues](https://github.com/Microsoft/vcpkg/issues) in vcpkg or existing packages * [Submit Fixes and New Packages](https://github.com/Microsoft/vcpkg/pulls) Please refer to our [Contribution guidelines](CONTRIBUTING.md) for more details. This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. ## License Code licensed under the [MIT License](LICENSE.txt).