mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-11-25 18:19:07 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
9f04533f30
vcpkg/docs/README.md

76 lines
4.3 KiB
Markdown
Raw Normal View History

[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
### Quick Start
[docs] Rename docs/index.md to docs/README.md (#16758) * Rename docs/index.md to docs/README.md * Update links to index.md
2021-03-19 06:03:30 +08:00
**The latest version of this documentation is available on [GitHub](https://github.com/Microsoft/vcpkg/tree/master/docs/README.md).**
[docs] Improve inter-document linking; add 'latest' links (#16502) * [docs] Improve inter-document linking; add 'latest' links * [docs] Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-12 08:37:49 +08:00
[docs] Fix typo in docs/index.md (#16522) The subject ("Your commitment") here is singular (IIUC). I thought this worth fixing as it's one of first things many folks will read about the project.
2021-03-11 03:33:41 +08:00
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!
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08: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 19:18:48 +08: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 19:24:19 +08:00
- [Packaging GitHub Repositories Example: libogg](examples/packaging-github-repos.md)
[docs] Fix broken links (#17566) * [docs] Fix broken links * Fix the charactor * Update the charactor
2021-04-30 04:39:50 +08:00
- [Patching Example: Patching libpng to work for x64-uwp](examples/patching.md)
[docs] Improve inter-document linking; add 'latest' links (#16502) * [docs] Improve inter-document linking; add 'latest' links * [docs] Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-12 08:37:49 +08:00
- [Getting Started with Versioning](examples/versioning.getting-started.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
### User Help
[docs] improve integrate documentation (#19700) * [docs] improve integrate documentation * Small suggestions Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-08-31 08:11:16 +08:00
- [Buildsystem Integration](users/integration.md)
[vcpkg-docs] Initial commit of triplets documentation
2017-06-07 02:40:47 +08: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-12 03:48:41 +08:00
- [Configuration and Environment](users/config-environment.md)
[docs] Add authentication.md (#20990) * [docs] Add docs/users/authentication.md * edits * Add link to README.md * Address CR comments * Fixup Co-authored-by: Robert Schumacher <ras0219@outlook.com>
2021-11-16 01:33:53 +08:00
- [Authentication](users/authentication.md)
[doc] Improve manifest documentation links (#17214) * Improve manifest documentation links * Update control-files.md Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-04-24 01:39:27 +08:00
- [Manifest Mode](users/manifests.md)
[docs] Improve inter-document linking; add 'latest' links (#16502) * [docs] Improve inter-document linking; add 'latest' links * [docs] Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-12 08:37:49 +08:00
- [Binary Caching](users/binarycaching.md)
[docs] Improve assetcaching.md (#19625) * Improve asset caching readme * Update assetcaching.md Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-08-18 08:33:44 +08:00
- [Asset Caching](users/assetcaching.md)
[docs] Improve inter-document linking; add 'latest' links (#16502) * [docs] Improve inter-document linking; add 'latest' links * [docs] Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-12 08:37:49 +08:00
- [Versioning](users/versioning.md)
[vcpkg] Improve Android doc (triplets, usage with cmake and prefab) (#11264) * Android: add docs/examples/vcpkg_android_example_cmake/ * Add docs/users/android.md * Improve Android prefab doc Following additional informations given by @atkawa7 at https://github.com/microsoft/vcpkg/pull/11264 * Link to android.md * Update the prefab usage instructions: "vcpkg install" the 4 archs before exporting a prefab * added --prefab-debug flag * added gradle integration info * reviewed the prefab output directory structure (from a dump of an actual export) * docs/users/triplets.md: link to android.md * docs/index.md: link to android.md * android.md: specify 2 possibiities for android_ndk_home * Added examples/vcpkg_android_example_cmake_script/cmake/vcpkg_android.cmake Usage: 1. Main CMakeLists: if (VCPKG_TARGET_ANDROID) include("cmake/vcpkg_android.cmake") endif() 2. cmake invocation: cmake .. -DVCPKG_TARGET_ANDROID=ON -DANDROID_ABI=armeabi-v7a * trigger pipeline build * trigger pipelines
2020-05-14 07:42:13 +08:00
- [Usage with Android](users/android.md)
[docs] Add mingw documentation (#17219) * Add mingw documentation * Minor edits * Fix typos * Revise comments about tools * Make mingw-w64 explicit * Fix another typo * How to avoid mixing different installations * Ban '/bin' from 'PATH', too * Update mingw.md Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-04-29 05:49:21 +08:00
- [Usage with Mingw-w64](users/mingw.md)
[host dependencies] add support in the scripts (#16627) This contains all the docs and scripts changes from #16479, without any of the ports changes, for easier CR
2021-03-11 07:33:16 +08:00
- [Host Dependencies](users/host-dependencies.md)
[docs registries] Add reference documentation (#17672) * using registries reference documentation * start work on "creating registries" document also fix minor issue in "using registries" doc * Robert's comments, continue working * finish creating registries docs * add links to example registries * aupopa cr
2021-05-07 03:13:29 +08:00
- [Using Registries](users/registries.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
[docs] Improve inter-document linking; add 'latest' links (#16502) * [docs] Improve inter-document linking; add 'latest' links * [docs] Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-12 08:37:49 +08:00
### Maintainer Help
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
[docs] Improve inter-document linking; add 'latest' links (#16502) * [docs] Improve inter-document linking; add 'latest' links * [docs] Apply suggestions from code review Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-12 08:37:49 +08:00
- [Manifest files - vcpkg.json](maintainers/manifest-files.md)
- [Control files](maintainers/control-files.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
- [Portfile functions](maintainers/portfile-functions.md)
add link to common vcpkg definitions (#17066)
2021-04-08 03:52:48 +08:00
- [Common CMake definitions](maintainers/vcpkg_common_definitions.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-22 12:33:29 +08:00
- [Maintainer Guidelines](maintainers/maintainer-guide.md)
[docs registries] Add reference documentation (#17672) * using registries reference documentation * start work on "creating registries" document also fix minor issue in "using registries" doc * Robert's comments, continue working * finish creating registries docs * add links to example registries * aupopa cr
2021-05-07 03:13:29 +08:00
- [Creating Registries](maintainers/registries.md)
[rollup:2021-07-06] Rollup PR (#18838) * [rollup:2021-07-06 1/8] PR #18272 (@strega-nil) [scripts-audit] vcpkg_from_* * [rollup:2021-07-06 2/8] PR #18319 (@strega-nil) [scripts-audit] add guidelines for cmake * [rollup 2021-07-06 3/8] PR #18410 (@mheyman) [vcpkg-cmake-config] documentation fix * [rollup:2021-07-06 4/8] PR #18488 (@strega-nil) [scripts-audit] vcpkg_execute_* * [rollup:2021-07-06 5/8] PR #18517 (@strega-nil) [scripts-audit] vcpkg_extract_source_archive * [rollup:2021-07-06 6/8] PR #18674 (@NancyLi1013) [vcpkg doc] Update examples * [rollup:2021-07-06 7/8] PR #18695 (@JackBoosY) [vcpkg] Update the minimum version of vcpkg * [rollup:2021-07-06 8/8] PR #18758 (@ras0219-msft) [vcpkg_from_git] Fix error if downloads folder does not exist * build docs! * fix bond:*-windows * fix nmap Co-authored-by: nicole mazzuca <mazzucan@outlook.com> Co-authored-by: Michael Heyman <Michael.Heyman@jhuapl.edu> Co-authored-by: NancyLi1013 <lirui09@beyondsoft.com> Co-authored-by: JackBoosY <yuzaiyang@beyondsoft.com> Co-authored-by: Robert Schumacher <ras0219@outlook.com>
2021-07-15 03:45:18 +08:00
- [CMake Guidelines](maintainers/cmake-guidelines.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
[docs] fix links for vcpkg-tool maintainer help (#16796) * [docs] fix links for vcpkg-tool maintainer help * Update docs/README.md Co-authored-by: Robert Schumacher <roschuma@microsoft.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-24 05:28:45 +08:00
### [Vcpkg-Tool](https://github.com/microsoft/vcpkg-tool) Maintainer Help
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-03 00:52:39 +08:00
[docs] fix links for vcpkg-tool maintainer help (#16796) * [docs] fix links for vcpkg-tool maintainer help * Update docs/README.md Co-authored-by: Robert Schumacher <roschuma@microsoft.com> Co-authored-by: Robert Schumacher <roschuma@microsoft.com>
2021-03-24 05:28:45 +08:00
- [Testing](https://github.com/microsoft/vcpkg-tool/tree/main/docs/testing.md)
- [Benchmarking](https://github.com/microsoft/vcpkg-tool/tree/main/docs/benchmarking.md)
- [Layout of the vcpkg source tree](https://github.com/microsoft/vcpkg-tool/tree/main/docs/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-03 00:52:39 +08:00
[docs] Add references to awesome community websites. Fixes #16278 (#16421)
2021-02-27 04:33:48 +08:00
### Community Resources (not directly affiliated with vcpkg)
Update to Community resources (#16489) - vcpkgx now also list older versions, no point in keeping the differentiator
2021-03-03 06:00:56 +08:00
- [vcpkg.info](https://vcpkg.info/) - Package index + search
[docs] Add references to awesome community websites. Fixes #16278 (#16421)
2021-02-27 04:33:48 +08:00
- [vcpkgx](https://vcpkgx.com/) - Package index + search
[docs] Add vcpkg.dev to community sites (#18031)
2021-05-21 15:35:53 +08:00
- [vcpkg index](https://vcpkg.dev/) - Package index + search
[docs] Add references to awesome community websites. Fixes #16278 (#16421)
2021-02-27 04:33:48 +08:00
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08: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-12 03:48:41 +08:00
- [Feature Packages](specifications/feature-packages.md)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs.
2017-05-25 14:33:16 +08:00
### Blog posts
add more blog posts (#17220)
2021-04-13 01:44:23 +08:00
- [Vcpkg Host Dependencies for Cross-Compilation](https://devblogs.microsoft.com/cppblog/vcpkg-host-dependencies/)
- [Registries: Bring your own libraries to vcpkg](https://devblogs.microsoft.com/cppblog/registries-bring-your-own-libraries-to-vcpkg/)
- [Vcpkg: Accelerate your team development environment with binary caching and manifests](https://devblogs.microsoft.com/cppblog/vcpkg-accelerate-your-team-development-environment-with-binary-caching-and-manifests/)
[doc] Add 2019.06 blog post (#17550)
2021-04-29 23:01:55 +08:00
- [Vcpkg: 2019.06 Update (overlay ports, overlay triplets, `vcpkg_check_features`)](https://devblogs.microsoft.com/cppblog/vcpkg-2019-06-update/)
Add crossplatform announcement to docs
2018-04-25 06:52:32 +08: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-17 00:25:44 +08: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-25 14:33:16 +08: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)
Reference in New Issue Copy Permalink