aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authornicole mazzuca <mazzucan@outlook.com>2020-09-14 15:07:02 -0700
committerGitHub <noreply@github.com>2020-09-14 15:07:02 -0700
commit0fec1340eba828e95c489796eb0c7a4330120686 (patch)
treea5e9f8e8592705c790ae0e987fd2b36219a3276d /README.md
parent76362dd2b2e4d9b03f6722219c8a1189e3a255fa (diff)
downloadvcpkg-0fec1340eba828e95c489796eb0c7a4330120686.tar.gz
vcpkg-0fec1340eba828e95c489796eb0c7a4330120686.zip
[vcpkg manifest] Add documentation! (#13488)
* [vcpkg docs] add docs for manifest files These are just for the maintainer docs, not user docs. * [vcpkg] EBNF-ify platform expression parsing this modifies nothing about what strings are accepted or rejected, it just moves stuff around. also adds tests. * [vcpkg docs] add manifest mode example * [wip] docs for augustin also fix tabs * [vcpkg manifest] switch to using maps for features * Apply suggestions from code review * un-experimentize format-manifest * flesh out the user manifest mode docs * CRs * billy CRs * final personal pass-thru
Diffstat (limited to 'README.md')
-rw-r--r--README.md51
1 files changed, 0 insertions, 51 deletions
diff --git a/README.md b/README.md
index 118932529..b75eb50dc 100644
--- a/README.md
+++ b/README.md
@@ -274,56 +274,6 @@ This will still allow people to not use vcpkg,
by passing the `CMAKE_TOOLCHAIN_FILE` directly,
but it will make the configure-build step slightly easier.
-## Quick Start: Manifests
-
-So, you want to look at what the future of vcpkg is going to be like!
-We really appreciate it 😄. First, though, a warning:
-manifest support in vcpkg is still in beta! Mostly, it should just work,
-but there are no guarantees and it's likely you'll hit at least a bug or two
-while you're using vcpkg in this mode. Additionally,
-we will likely break behavior before stabilizing, so be forewarned.
-Please [open issues][contributing:submit-issue] if you hit any bugs!
-
-First, install vcpkg as normal for [Windows](#quick-start-windows) or
-[Unix](#quick-start-unix).
-You may wish to install vcpkg in a central place,
-as the installed directory exists locally,
-and it's fine to run multiple vcpkg commands from the same
-vcpkg directory at the same time.
-
-Then, we must turn on the `manifests` vcpkg feature flag by adding
-`manifests` to the comma-separated `--feature-flags` option,
-or by adding it to the comma-separated `VCPKG_FEATURE_FLAGS`
-environment variable.
-
-You may also want to add vcpkg to the `PATH`.
-
-Then, all one has to do is create a manifest;
-create a file called `vcpkg.json`, and type the following:
-
-```json
-{
- "name": "<name of your project>",
- "version-string": "<version of your project>",
- "dependencies": [
- "abseil",
- "boost"
- ]
-}
-```
-
-The libraries will be installed into the `vcpkg_installed`
-directory, in the same directory as your `vcpkg.json`.
-If you can use the regular CMake toolchain,
-or the Visual Studio/MSBuild integration,
-it will install the dependencies automatically,
-although you will need to set `VcpkgManifestEnabled` to `On` for MSBuild.
-If you wish to install your dependencies without using either CMake or MSBuild,
-you may use a simple `vcpkg install --feature-flags=manifests`
-
-For more information, check out the [manifest][getting-started:manifest-spec]
-specification.
-
[getting-started:using-a-package]: docs/examples/installing-and-using-packages.md
[getting-started:integration]: docs/users/integration.md
[getting-started:git]: https://git-scm.com/downloads
@@ -333,7 +283,6 @@ specification.
[getting-started:macos-brew]: #installing-gcc-on-macos
[getting-started:macos-gcc]: #installing-gcc-on-macos
[getting-started:visual-studio]: https://visualstudio.microsoft.com/
-[getting-started:manifest-spec]: docs/specifications/manifests.md
# Tab-Completion/Auto-Completion