From e0397ceee313ddb114fd9f80ca9d67ce1fa10838 Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Thu, 6 Feb 2020 13:27:09 +0100 Subject: [PATCH] README.md: Document compile options. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 681e68c..9f8d964 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,18 @@ C:\repo\build> cmake -D OPENSSL_ROOT_DIR="C:/path/to/openssl-1.1/x86" .. C:\repo\build> cmake --build . --config Release ``` +## Compile options + +These compile options are available: + +| Cmake | build.sh | Description | +|--------------------------- | ----------------- | ------------------------------------------| +| -DCMAKE_BUILD_TYPE=`value` | -t `value` | Type of build | +| -DUSE_THREADS=`OFF` | --disable-threads | Disable thread support | +| -DFORCE_ANSI=`ON` | --force-ansi | Force ANSI console colors even on windows | + +For more details about options run `./build.sh -l` or `mkdir build && cmake build -LA` + ## Install After the project has been compiled. run `sudo ./install.sh` or the following code if you dont want to use that: