vcpkg/README.md

# Vcpkg <a href="#">![](https://devdiv.visualstudio.com/_apis/public/build/definitions/0bdbc590-a062-4c3f-b0f6-9383f67865ee/5261/badge)</a>

## 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: <https://vcpkg.readthedocs.io/>!

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).
Make badge non-clickable 2017-05-13 02:46:58 +08:00			`# Vcpkg <a href="#">![](https://devdiv.visualstudio.com/_apis/public/build/definitions/0bdbc590-a062-4c3f-b0f6-9383f67865ee/5261/badge)</a>`
Fix link to documentation in README 2017-06-08 06:26:55 +08:00
Initial commit 2016-09-19 11:50:08 +08:00			`## 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`
[README] Note requirement for git.exe to be available on the path 2016-11-02 12:51:28 +08:00			`Prerequisites:`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00			`- Windows 10, 8.1, or 7`
			`- Visual Studio 2017 or Visual Studio 2015 Update 3`
			`- Git`
Update CMake to 3.10.2 2018-01-20 07:12:21 +08:00			`- Optional: CMake 3.10.2`
[README] Note requirement for git.exe to be available on the path 2016-11-02 12:51:28 +08:00
			`Clone this repository, then run`
Initial commit 2016-09-19 11:50:08 +08:00			```
[vcpkg] Add bootstrap-vcpkg.bat to improve first-time experience. 2017-04-01 18:58:45 +08:00			`C:\src\vcpkg> .\bootstrap-vcpkg.bat`
Initial commit 2016-09-19 11:50:08 +08:00			```
			`Then, to hook up user-wide integration, run (note: requires admin on first use)`
			```
			`C:\src\vcpkg> .\vcpkg integrate install`
			```
[Readme.md] Add comment about VS integration 2016-09-20 04:43:11 +08:00			`Install any packages with`
Initial commit 2016-09-19 11:50:08 +08:00			```
			`C:\src\vcpkg> .\vcpkg install sdl2 curl`
			```
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00			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.`
Initial commit 2016-09-19 11:50:08 +08:00
[autocomplete] Add info in README.md 2017-12-05 08:01:16 +08:00			`## 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.`


Initial commit 2016-09-19 11:50:08 +08:00			`## Examples`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00			`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).`
Initial commit 2016-09-19 11:50:08 +08:00
Fix link to documentation in README 2017-06-08 06:26:55 +08:00			`Our docs are now also available online at ReadTheDocs: <https://vcpkg.readthedocs.io/>!`
[vcpkg-docs] Initial commit of triplets documentation 2017-06-07 02:40:47 +08:00
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00			`See a 4 minute [video demo](https://www.youtube.com/watch?v=y41WFKbQFTw).`
Initial commit 2016-09-19 11:50:08 +08:00
			`## 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)`

Fixed link to CONTRIBUTING.md 2016-11-02 00:59:19 +08:00			`Please refer to our [Contribution guidelines](CONTRIBUTING.md) for more details.`
Initial commit 2016-09-19 11:50:08 +08:00
			`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).`