From 86864746c40d3a1394996bdcaad163c2d7c67862 Mon Sep 17 00:00:00 2001 From: Simon Gene Gottlieb Date: Tue, 26 Mar 2024 11:36:55 +0100 Subject: [PATCH] doc: extend README mentioning shorthand syntax with options --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c30138cc..a4e2a5d1 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ Afterwards, any targets defined in the dependency can be used directly. ```cmake CPMAddPackage( + URI # shorthand including repo, name, version and tag (see shorthand syntax) NAME # The unique name of the dependency (should be the exported target's name) VERSION # The minimum version of the dependency (optional, defaults to 0) PATCHES # Patch files to be applied sequentially using patch and PATCH_OPTIONS (optional) @@ -87,7 +88,7 @@ If an additional optional parameter `SYSTEM` is set to a truthy value, the SYSTE See the [add_subdirectory ](https://cmake.org/cmake/help/latest/command/add_subdirectory.html?highlight=add_subdirectory) and [SYSTEM](https://cmake.org/cmake/help/latest/prop_tgt/SYSTEM.html#prop_tgt:SYSTEM) target property for details. -A single-argument compact syntax is also supported: +A shorthand syntax is also supported: ```cmake # A git package from a given uri with a version @@ -111,6 +112,13 @@ CPMAddPackage("https://example.com/my-package-1.2.3.zip#MD5=68e20f674a48be38d60e CPMAddPackage("https://example.com/my-package.zip@1.2.3") ``` +Additionally, the shorthand syntax can be used with the URI and combined with the other options from above: +```cmake +CPMAddPackage("gh:nlohmann/json@3.9.1" + OPTIONS "JSON_BuildTests OFF" +) +``` + After calling `CPMAddPackage`, the following variables are defined in the local scope, where `` is the name of the dependency. - `_SOURCE_DIR` is the path to the source of the dependency.