diff options
| author | autoantwort <41973254+autoantwort@users.noreply.github.com> | 2021-03-18 23:03:30 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-18 15:03:30 -0700 |
| commit | 20fad538fda23e4d3a784c257fd8064ababbbb5a (patch) | |
| tree | 0aaa4e0d3b96992506bd12967d4295dedaed2d10 /docs/README.md | |
| parent | 4987faf90df0bb88d8495177162873d75c1decde (diff) | |
| download | vcpkg-20fad538fda23e4d3a784c257fd8064ababbbb5a.tar.gz vcpkg-20fad538fda23e4d3a784c257fd8064ababbbb5a.zip | |
[docs] Rename docs/index.md to docs/README.md (#16758)
* Rename docs/index.md to docs/README.md
* Update links to index.md
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..167af1b63 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,63 @@ +### Quick Start + +**The latest version of this documentation is available on [GitHub](https://github.com/Microsoft/vcpkg/tree/master/docs/README.md).** + +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! + +### 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) +- [Getting Started with Versioning](examples/versioning.getting-started.md) + +### User Help + +- [Integration with build systems](users/integration.md) +- [Triplet files](users/triplets.md) +- [Configuration and Environment](users/config-environment.md) +- [Manifests](users/manifests.md) +- [Binary Caching](users/binarycaching.md) +- [Versioning](users/versioning.md) +- [Usage with Android](users/android.md) +- [Host Dependencies](users/host-dependencies.md) + +### Maintainer Help + +- [Manifest files - vcpkg.json](maintainers/manifest-files.md) +- [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) + +### Community Resources (not directly affiliated with vcpkg) + +- [vcpkg.info](https://vcpkg.info/) - Package index + search +- [vcpkgx](https://vcpkgx.com/) - Package index + search + +### 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) |
