From 20fad538fda23e4d3a784c257fd8064ababbbb5a Mon Sep 17 00:00:00 2001 From: autoantwort <41973254+autoantwort@users.noreply.github.com> Date: Thu, 18 Mar 2021 23:03:30 +0100 Subject: [docs] Rename docs/index.md to docs/README.md (#16758) * Rename docs/index.md to docs/README.md * Update links to index.md --- CHANGELOG.md | 6 +++--- README_es.md | 4 ++-- README_fr.md | 4 ++-- README_ko_KR.md | 4 ++-- README_zh_CN.md | 4 ++-- docs/README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ docs/index.md | 63 --------------------------------------------------------- 7 files changed, 74 insertions(+), 74 deletions(-) create mode 100644 docs/README.md delete mode 100644 docs/index.md diff --git a/CHANGELOG.md b/CHANGELOG.md index ede56fb30..83e1239f3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -124,7 +124,7 @@ vcpkg (2020.11.01) - [(#13488)](https://github.com/microsoft/vcpkg/pull/13488) [vcpkg manifest] Add documentation! (by @strega-nil) - [Packaging Github Repos Example: libogg](docs/examples/packaging-github-repos.md) - [(#13488)](https://github.com/microsoft/vcpkg/pull/13488) [vcpkg manifest] Add documentation! (by @strega-nil) -- [Quick Start](docs/index.md) +- [Quick Start](docs/README.md) - [(#13488)](https://github.com/microsoft/vcpkg/pull/13488) [vcpkg manifest] Add documentation! (by @strega-nil) - [Manifest files - `vcpkg.json`](docs/maintainers/manifest-files.md)***[NEW]*** - [(#13488)](https://github.com/microsoft/vcpkg/pull/13488) [vcpkg manifest] Add documentation! (by @strega-nil) @@ -6983,7 +6983,7 @@ vcpkg (2019.08.31) - [(#7950)](https://github.com/microsoft/vcpkg/pull/7950) [vcpkg install] Enable Download Mode ⏬ #### The following documentation has been updated: -- [Index](docs/index.md) +- [Index](docs/README.md) - [(#7506)](https://github.com/microsoft/vcpkg/pull/7506) Update tests, and add documentation! - [(#7821)](https://github.com/microsoft/vcpkg/pull/7821) [vcpkg docs] More tool maintainer docs! 🐱‍👤 - [Tool maintainers: Testing](docs/tool-maintainers/testing.md) ***[NEW]*** @@ -8432,7 +8432,7 @@ vcpkg (2019.6.30) - [CONTROL files](docs/maintainers/control-files.md#Homepage) - [(#6844)](https://github.com/Microsoft/vcpkg/pull/6844) [vcpkg] Add optional 'Homepage' field to CONTROL - [(#6871)](https://github.com/Microsoft/vcpkg/pull/6871) [docs] Add maintainer guidelines -- [index](docs/index.md) +- [index](docs/README.md) - [(#6871)](https://github.com/Microsoft/vcpkg/pull/6871) [docs] Add maintainer guidelines - [Portfile helper functions](docs/maintainers/portfile-functions.md) - [(#7039)](https://github.com/Microsoft/vcpkg/pull/7039) [docs]Update cmake docs diff --git a/README_es.md b/README_es.md index 19211b0f5..161e30c8c 100644 --- a/README_es.md +++ b/README_es.md @@ -19,7 +19,7 @@ una vez instalado Vcpkg puede ejecutar `vcpkg help`, o * Github: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg) * Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/), en el canal #vcpkg * Discord: [\#include \](https://www.includecpp.org), en el canal #🌏vcpkg -* Docs: [Documentación](docs/index.md) +* Docs: [Documentación](docs/README.md) [![Estado de compilación](https://dev.azure.com/vcpkg/public/_apis/build/status/microsoft.vcpkg.ci?branchName=master)](https://dev.azure.com/vcpkg/public/_build/latest?definitionId=29&branchName=master) @@ -360,7 +360,7 @@ según la terminal que use, luego reinicie la consola. ## Ejemplos -ver la [documentación](docs/index.md) para tutoriales específicos, incluyendo +ver la [documentación](docs/README.md) para tutoriales específicos, incluyendo [instalando y usando un paquete](docs/examples/installing-and-using-packages.md), [agregando un nuevo paquete desde un archivo comprimido](docs/examples/packaging-zipfiles.md), [agregando un nuevo paquete desde un repositorio en GitHub](docs/examples/packaging-github-repos.md). diff --git a/README_fr.md b/README_fr.md index cb6b13db0..f39c09b03 100644 --- a/README_fr.md +++ b/README_fr.md @@ -14,7 +14,7 @@ Pour une description des commandes disponibles, quand vous avez installé vcpkg, * Github: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg) * Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/), the #vcpkg channel * Discord: [\#include \](https://www.includecpp.org), le canal #🌏vcpkg -* Docs: [Documentation](docs/index.md) +* Docs: [Documentation](docs/README.md) [![Build Status](https://dev.azure.com/vcpkg/public/_apis/build/status/microsoft.vcpkg.ci?branchName=master)](https://dev.azure.com/vcpkg/public/_build/latest?definitionId=29&branchName=master) @@ -274,7 +274,7 @@ selon le shell que vous utilisez, puis redémarrez la console. # Exemples -Lisez la [documentation](doc/index.md) pour des instructions plus spécifiques ainsi que [l'installation et l'utilisation des paquets](docs/examples/installing-and-using-packages.md), +Lisez la [documentation](doc/README.md) pour des instructions plus spécifiques ainsi que [l'installation et l'utilisation des paquets](docs/examples/installing-and-using-packages.md), [ajouter un nouveau paquet depuis un fichier zip](docs/examples/packaging-zipfiles.md), et [ajouter un nouveau paquet depuis un dépôt GitHub](docs/examples/packaging-github-repos.md). diff --git a/README_ko_KR.md b/README_ko_KR.md index eb707e76c..74b888f99 100644 --- a/README_ko_KR.md +++ b/README_ko_KR.md @@ -11,7 +11,7 @@ vcpkg 사용을 시작하는 방법은 [시작하기](#시작하기) 섹션을 * Github: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg) * Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/), #vcpkg 채널 * Discord: [\#include \](https://www.includecpp.org), #🌏vcpkg 채널 -* Docs: [Documentation](docs/index.md) +* Docs: [Documentation](docs/README.md) [![Build Status](https://dev.azure.com/vcpkg/public/_apis/build/status/microsoft.vcpkg.ci?branchName=master)](https://dev.azure.com/vcpkg/public/_build/latest?definitionId=29&branchName=master) @@ -294,7 +294,7 @@ $ ./vcpkg integrate bash # 예제 -구체적인 연습은 [문서](docs/index.md)를 참고하세요, +구체적인 연습은 [문서](docs/README.md)를 참고하세요, including [패키지 설치 및 사용](docs/examples/installing-and-using-packages.md), [zip 파일에서 새 패키지 추가](docs/examples/packaging-zipfiles.md), 및 [GitHub 저장소에서 새 패키지 추가](docs/examples/packaging-github-repos.md). diff --git a/README_zh_CN.md b/README_zh_CN.md index e6ce57240..319537864 100644 --- a/README_zh_CN.md +++ b/README_zh_CN.md @@ -12,7 +12,7 @@ Vcpkg 可帮助您在 Windows、 Linux 和 MacOS 上管理 C 和 C++ 库。 * Github: [https://github.com/microsoft/vcpkg](https://github.com/microsoft/vcpkg) * Slack: [https://cppalliance.org/slack/](https://cppalliance.org/slack/)， #vcpkg 频道 * Discord: [\#include \](https://www.includecpp.org)， #🌏vcpkg 频道 -* 文档: [Documentation](docs/index.md) +* 文档: [Documentation](docs/README.md) [![当前生成状态](https://dev.azure.com/vcpkg/public/_apis/build/status/microsoft.vcpkg.ci?branchName=master)](https://dev.azure.com/vcpkg/public/_build/latest?definitionId=29&branchName=master) @@ -286,7 +286,7 @@ $ ./vcpkg integrate bash ## 示例 -请查看 [文档](docs/index.md) 获取具体示例， +请查看 [文档](docs/README.md) 获取具体示例， 其包含 [安装并使用包](docs/examples/installing-and-using-packages.md)， [使用压缩文件添加包](docs/examples/packaging-zipfiles.md) 和 [从GitHub源中添加一个包](docs/examples/packaging-github-repos.md)。 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) diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 00a17a5b4..000000000 --- a/docs/index.md +++ /dev/null @@ -1,63 +0,0 @@ -### Quick Start - -**The latest version of this documentation is available on [GitHub](https://github.com/Microsoft/vcpkg/tree/master/docs/index.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) -- cgit v1.2.3