From c6accf51517d5c44fcca7e0006541b1fa8470a18 Mon Sep 17 00:00:00 2001
From: xmrig <support@xmrig.com>
Date: Sun, 15 Sep 2019 15:26:22 +0700
Subject: [PATCH] Create CMAKE_OPTIONS.md

---
 doc/build/CMAKE_OPTIONS.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 doc/build/CMAKE_OPTIONS.md

diff --git a/doc/build/CMAKE_OPTIONS.md b/doc/build/CMAKE_OPTIONS.md
new file mode 100644
index 000000000..b201f2587
--- /dev/null
+++ b/doc/build/CMAKE_OPTIONS.md
@@ -0,0 +1,23 @@
+# CMake options
+This document contains list of useful cmake options.
+
+## Algorithms
+
+* **`-DWITH_CN_LITE=OFF`** disable all CryptoNight-Lite algorithms (`cn-lite/0`, `cn-lite/1`).
+* **`-DWITH_CN_HEAVY=OFF`** disable all CryptoNight-Heavy algorithms (`cn-heavy/0`, `cn-heavy/xhv`, `cn-heavy/tube`).
+* **`-DWITH_CN_PICO=OFF`** disable CryptoNight-Pico algorithm (`cn-pico`).
+* **`-DWITH_CN_GPU=OFF`** disable CryptoNight-GPU algorithm (`cn/gpu`).
+* **`-DWITH_RANDOMX=OFF`** disable RandomX algorithms (`rx/loki`, `rx/wow`).
+* **`-DWITH_ARGON2=OFF`** disable Argon2 algorithms (`argon2/chukwa`, `argon2/wrkz`).
+
+## Features
+
+* **`-DWITH_HWLOC=OFF`**
+disable [hwloc](https://github.com/xmrig/xmrig/issues/1077) support.
+Disabling this feature is not recommended in most cases.
+This feature add external dependency to libhwloc (1.10.0+) (except MSVC builds).
+* **`-DWITH_LIBCPUID=OFF`** disable built in libcpuid support, this feature always disabled if hwloc enabled, if both hwloc and libcpuid disabled auto configuration for CPU will very limited.
+* **`-DWITH_HTTP=OFF`** disable built in HTTP support, this feature used for HTTP API and daemon (solo mining) support.
+* **`-DWITH_TLS=OFF`** disable SSL/TLS support (secure connections to pool). This feature add external dependency to OpenSSL.
+* **`-DWITH_ASM=OFF`** disable assembly optimizations for modern CryptoNight algorithms.
+* **`-DWITH_EMBEDDED_CONFIG=ON`** Enable [embedded](https://github.com/xmrig/xmrig/issues/957) config support.