vcpkg/docs/index.md

### Quick Start

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

### Examples

- [Installing and Using Packages Example: sqlite](examples/installing-and-using-packages.md)
- [Packaging Zipfiles Example: zlib](examples/packaging-zipfiles.md)
- [Packaging GitHub Repositories Example: libogg](examples/packaging-github-repos.md)
- [Patching Example: Patching libpng to work for x86-uwp](examples/patching.md)

### User Help

- [Integration with build systems](users/integration.md)
- [Triplet files](users/triplets.md)
- [Configuration and Environment](users/config-environment.md)

### Maintainer help

- [Control files](maintainers/control-files.md)
- [Portfile functions](maintainers/portfile-functions.md)
- [Maintainer Guidelines](maintainers/maintainer-guide.md)

### Tool Maintainer Help

- [Testing](tool-maintainers/testing.md)
- [Benchmarking](tool-maintainers/benchmarking.md)
- [Layout of the vcpkg source tree](tool-maintainers/layout.md)
- [Maintainer Guidelines](maintainers/maintainer-guide.md)

### Specifications

- [Export](specifications/export-command.md)
- [Feature Packages](specifications/feature-packages.md)

### Blog posts
- [Announcing a single C++ library manager for Linux, macOS and Windows: Vcpkg](https://blogs.msdn.microsoft.com/vcblog/2018/04/24/announcing-a-single-c-library-manager-for-linux-macos-and-windows-vcpkg/)
- [Vcpkg: Using multiple enlistments to handle multiple versions of a library](https://blogs.msdn.microsoft.com/vcblog/2017/10/23/vcpkg-using-multiple-enlistments/)
- [Vcpkg: introducing the export command](https://blogs.msdn.microsoft.com/vcblog/2017/05/03/vcpkg-introducing-export-command/)
- [Binary Compatibility and Pain-free Upgrade Why Moving to Visual Studio 2017 is almost "too easy"](https://blogs.msdn.microsoft.com/vcblog/2017/03/07/binary-compatibility-and-pain-free-upgrade-why-moving-to-visual-studio-2017-is-almost-too-easy/)
- [Vcpkg recent enhancements](https://blogs.msdn.microsoft.com/vcblog/2017/02/14/vcpkg-recent-enhancements/)
- [Vcpkg 3 Months Anniversary, Survey](https://blogs.msdn.microsoft.com/vcblog/2017/01/11/vcpkg-3-months-anniversary-survey/)
- [Vcpkg updates: Static linking is now available](https://blogs.msdn.microsoft.com/vcblog/2016/11/01/vcpkg-updates-static-linking-is-now-available/)
- [Vcpkg: a tool to acquire and build C++ open source libraries on Windows](https://blogs.msdn.microsoft.com/vcblog/2016/09/19/vcpkg-a-tool-to-acquire-and-build-c-open-source-libraries-on-windows/)

### Other

- [FAQ](about/faq.md)
- [Privacy](about/privacy.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-24 23:33:16 -07:00			`### Quick Start`

Update documentation 2018-06-08 16:33:38 -07:00			`Vcpkg helps you manage C and C++ libraries on Windows, Linux and MacOS. This tool and ecosystem are constantly evolving; your involvement are vital to its success!`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-24 23:33:16 -07:00
			`### Examples`

Rename example documents The current names and titles of the examples put too much emphasis on the package which is being demonstrated rather than the concept. This can be jarring for newcomers. This patch renames them to put the emphasis on the concept instead. 2018-11-15 11:18:48 +00:00			`- [Installing and Using Packages Example: sqlite](examples/installing-and-using-packages.md)`
			`- [Packaging Zipfiles Example: zlib](examples/packaging-zipfiles.md)`
Add packaging GitHub repo example 2018-11-16 11:24:19 +00:00			`- [Packaging GitHub Repositories Example: libogg](examples/packaging-github-repos.md)`
Rename example documents The current names and titles of the examples put too much emphasis on the package which is being demonstrated rather than the concept. This can be jarring for newcomers. This patch renames them to put the emphasis on the concept instead. 2018-11-15 11:18:48 +00:00			`- [Patching Example: Patching libpng to work for x86-uwp](examples/patching.md)`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-24 23:33:16 -07:00
			`### User Help`

			`- [Integration with build systems](users/integration.md)`
[vcpkg-docs] Initial commit of triplets documentation 2017-06-06 11:40:47 -07:00			`- [Triplet files](users/triplets.md)`
Allow redirection of the downloads folder with an environment variable. (#4883) * Add detection for VCPKG_DOWNLOADS environment variable in vcpkgpaths.cpp. * Pass the downloads directory from VcpkgPaths to cmake. * Also fixup bootstrap on nix. Make error message a little prettier. * Make that bash script actually work :) * [vcpkg] Alter Optional<> usage style * [vcpkg-docs] Add section on Environment Variables to the docs 2018-12-11 11:48:41 -08:00			`- [Configuration and Environment](users/config-environment.md)`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-24 23:33:16 -07:00
			`### Maintainer help`

			`- [Control files](maintainers/control-files.md)`
			`- [Portfile functions](maintainers/portfile-functions.md)`
[docs] Add maintainer guidelines (#6871) * [maintainer-guide] Initial commit of maintainer guidelines * [maintainer-guide] Rearrange sections * [maintainer-guide] Add note about GitHub Draft PRs * [maintainer-guide] Improvements * [maintainer-guide] Address comments about versioning conventions * [maintainer-guide] Add section about how portfiles interact with CMakeLists.txt * [maintainer-guidelines] Add link from docs index 2019-06-21 21:33:29 -07:00			`- [Maintainer Guidelines](maintainers/maintainer-guide.md)`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-24 23:33:16 -07:00
Update tests, and add documentation! (#7506) This PR does the following: * fix tests -- now, they're always built in the CMake scripts, and they work on VS2015 add a new flag, BUILD_TESTING, which allows one to turn off testing builds Add documentation for running tests 2019-08-02 09:52:39 -07:00			`### Tool Maintainer Help`

			`- [Testing](tool-maintainers/testing.md)`
[vcpkg docs] More tool maintainer docs! (#7821) * [vcpkg docs] Add benchmarking 🏎 to the docs! Also, minor changes to the testing docs. * add documentation for the layout of the project 2019-08-24 11:36:12 -07:00			`- [Benchmarking](tool-maintainers/benchmarking.md)`
			`- [Layout of the vcpkg source tree](tool-maintainers/layout.md)`
Update tests, and add documentation! (#7506) This PR does the following: * fix tests -- now, they're always built in the CMake scripts, and they work on VS2015 add a new flag, BUILD_TESTING, which allows one to turn off testing builds Add documentation for running tests 2019-08-02 09:52:39 -07:00			`- [Maintainer Guidelines](maintainers/maintainer-guide.md)`

[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-24 23:33:16 -07:00			`### Specifications`

			`- [Export](specifications/export-command.md)`
Allow redirection of the downloads folder with an environment variable. (#4883) * Add detection for VCPKG_DOWNLOADS environment variable in vcpkgpaths.cpp. * Pass the downloads directory from VcpkgPaths to cmake. * Also fixup bootstrap on nix. Make error message a little prettier. * Make that bash script actually work :) * [vcpkg] Alter Optional<> usage style * [vcpkg-docs] Add section on Environment Variables to the docs 2018-12-11 11:48:41 -08:00			`- [Feature Packages](specifications/feature-packages.md)`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-24 23:33:16 -07:00
			`### Blog posts`
Add crossplatform announcement to docs 2018-04-24 18:52:32 -04:00			`- [Announcing a single C++ library manager for Linux, macOS and Windows: Vcpkg](https://blogs.msdn.microsoft.com/vcblog/2018/04/24/announcing-a-single-c-library-manager-for-linux-macos-and-windows-vcpkg/)`
adding a blog link in the doc 2018-05-16 09:25:44 -07:00			`- [Vcpkg: Using multiple enlistments to handle multiple versions of a library](https://blogs.msdn.microsoft.com/vcblog/2017/10/23/vcpkg-using-multiple-enlistments/)`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-24 23:33:16 -07:00			`- [Vcpkg: introducing the export command](https://blogs.msdn.microsoft.com/vcblog/2017/05/03/vcpkg-introducing-export-command/)`
			`- [Binary Compatibility and Pain-free Upgrade Why Moving to Visual Studio 2017 is almost "too easy"](https://blogs.msdn.microsoft.com/vcblog/2017/03/07/binary-compatibility-and-pain-free-upgrade-why-moving-to-visual-studio-2017-is-almost-too-easy/)`
			`- [Vcpkg recent enhancements](https://blogs.msdn.microsoft.com/vcblog/2017/02/14/vcpkg-recent-enhancements/)`
			`- [Vcpkg 3 Months Anniversary, Survey](https://blogs.msdn.microsoft.com/vcblog/2017/01/11/vcpkg-3-months-anniversary-survey/)`
			`- [Vcpkg updates: Static linking is now available](https://blogs.msdn.microsoft.com/vcblog/2016/11/01/vcpkg-updates-static-linking-is-now-available/)`
			`- [Vcpkg: a tool to acquire and build C++ open source libraries on Windows](https://blogs.msdn.microsoft.com/vcblog/2016/09/19/vcpkg-a-tool-to-acquire-and-build-c-open-source-libraries-on-windows/)`

			`### Other`

			`- [FAQ](about/faq.md)`
			`- [Privacy](about/privacy.md)`