summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Pipping <sebastian@pipping.org>2019-08-31 00:59:57 +0200
committerSebastian Pipping <sebastian@pipping.org>2019-08-31 00:59:57 +0200
commit51bdd9a3cb70c9020715cfe883f606cd5b995b7a (patch)
treec680bfa3da8a1811d4476ad1825cad760b42f3e2
parent769d62d0804c1a5055e30406eeaa2284f17958d3 (diff)
downloaduriparser-51bdd9a3cb70c9020715cfe883f606cd5b995b7a.tar.gz
README.md: Improve CMake option listing
-rw-r--r--README.md26
1 files changed, 17 insertions, 9 deletions
diff --git a/README.md b/README.md
index 8306956..ded8fd0 100644
--- a/README.md
+++ b/README.md
@@ -45,29 +45,37 @@ target_link_libraries(hello PUBLIC uriparser::uriparser)
## Available CMake options (and defaults)
```console
-# rm -f CMakeCache.txt ; cmake -LAH | grep -B1 'URIPARSER_\|BUILD_SHARED_LIBS'
-[..]
+# rm -f CMakeCache.txt ; cmake -LH . | grep -B1 ':.*=' | sed 's,--,,'
// Build shared libraries (rather than static ones)
BUILD_SHARED_LIBS:BOOL=ON
---
+
+// Choose the type of build, options are: None Debug Release RelWithDebInfo MinSizeRel ...
+CMAKE_BUILD_TYPE:STRING=
+
+// Install path prefix, prepended onto install directories.
+CMAKE_INSTALL_PREFIX:PATH=/usr/local
+
+// Path to a program.
+QHG_LOCATION:FILEPATH=/usr/bin/qhelpgenerator
+
// Build code supporting data type 'char'
URIPARSER_BUILD_CHAR:BOOL=ON
---
+
// Build API documentation (requires Doxygen, Graphviz, and (optional) Qt's qhelpgenerator)
URIPARSER_BUILD_DOCS:BOOL=ON
---
+
// Build test suite (requires GTest >=1.8.0)
URIPARSER_BUILD_TESTS:BOOL=ON
---
+
// Build tools (e.g. CLI "uriparse")
URIPARSER_BUILD_TOOLS:BOOL=ON
---
+
// Build code supporting data type 'wchar_t'
URIPARSER_BUILD_WCHAR_T:BOOL=ON
---
+
// Enable installation of uriparser
URIPARSER_ENABLE_INSTALL:BOOL=ON
---
+
// Use of specific runtime library (/MT /MTd /MD /MDd) with MSVC
URIPARSER_MSVC_RUNTIME:STRING=
```