From 320b4e88e1ea7a3e0f03b1ed59302281e5d3e30b Mon Sep 17 00:00:00 2001 From: Alejandro Saucedo Date: Sun, 13 Sep 2020 11:57:57 +0100 Subject: [PATCH] Updated build param table --- README.md | 25 +++++++++---------------- 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6ad1b4489..4fd0394bd 100644 --- a/README.md +++ b/README.md @@ -259,22 +259,15 @@ cmake -Bbuild This by default configures without any of the extra build tasks (such as building shaders) and compiles without the optional dependencies. The table below provides more detail. -|-------------------------------------|--------------------------------------------------------------------------| -| -DKOMPUTE_ENABLE_SPDLOG=1 | Enables the build with SPDLOG and FMT dependencies (must be installed) | -|-------------------------------------|--------------------------------------------------------------------------| -| -DCMAKE_INSTALL_PREFIX=\ | Enables local installation (which won't require admin privileges) | -| "build/src/CMakefiles/Export/" | This can be used for the standalone samples in the examples folder | -|-------------------------------------|--------------------------------------------------------------------------| -| -DCMAKE_TOOLCHAIN_FILE="..." | This is the path for your package manager if you use it such as vcpkg | -|-------------------------------------|--------------------------------------------------------------------------| -| -DKOMPUTE_OPT_BUILD_TESTS=1 | Enable if you wish to build and run the tests (must have deps installed. | -|-------------------------------------|--------------------------------------------------------------------------| -| -DKOMPUTE_OPT_BUILD_DOCS=1 | Enable if you wish to build the docs (must have docs deps installed) | -|-------------------------------------|--------------------------------------------------------------------------| -| -DKOMPUTE_OPT_BUILD_SINGLE_HEADER=1 | Option to build the single header file using "quom" utility | -|-------------------------------------|--------------------------------------------------------------------------| -| -DKOMPUTE_EXTRA_CXX_FLAGS="..." | Allows you to pass extra config flags to compiler | -|-------------------------------------|--------------------------------------------------------------------------| +| Flag | Description | +|-------------------------------------------------------|--------------------------------------------------------------------------| +| -DKOMPUTE_ENABLE_SPDLOG=1 | Enables the build with SPDLOG and FMT dependencies (must be installed) | +| -DCMAKE_INSTALL_PREFIX="build/src/CMakefiles/Export/" | Enables local installation (which won't require admin privileges) | +| -DCMAKE_TOOLCHAIN_FILE="..." | This is the path for your package manager if you use it such as vcpkg | +| -DKOMPUTE_OPT_BUILD_TESTS=1 | Enable if you wish to build and run the tests (must have deps installed. | +| -DKOMPUTE_OPT_BUILD_DOCS=1 | Enable if you wish to build the docs (must have docs deps installed) | +| -DKOMPUTE_OPT_BUILD_SINGLE_HEADER=1 | Option to build the single header file using "quom" utility | +| -DKOMPUTE_EXTRA_CXX_FLAGS="..." | Allows you to pass extra config flags to compiler | ### Dependencies