From 33fffb1644e23dc6a997fab1968996e4c555c4d4 Mon Sep 17 00:00:00 2001 From: Dennis Klein Date: Tue, 10 Apr 2018 19:58:30 +0200 Subject: [PATCH] Update README --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8701fe42..a311eb2e 100644 --- a/README.md +++ b/README.md @@ -43,12 +43,25 @@ find_package(ZeroMQ) # ... ``` -The above allows you to customize the `find_package` calls in the case, you project also has a direct dependency to FairMQ's dependencies. Check the next section for more options on how to customize dependency discovery. +The above is useful, if you need to customize the `find_package` calls of FairMQ's dependencies. Check the next section for more CMake options. ## CMake options +TODO complete list + +On command line: + * `-DDISABLE_COLOR=ON` disables coloured console output. - * `-DFairMQ_PACKAGE_DEPENDENCIES_DISABLED=ON` disables transitive package dependency discovery. + * `-DBUILD_OFI_TRANSPORT=ON` enables building of the experimental OFI transport. + +In front of the `find_package(FairMQ)` call: + + * `set(BUILD_OFI_TRANSPORT ON)` enables building of the experimental OFI transport. + * `set(FairMQ_PACKAGE_DEPENDENCIES_DISABLED ON)` disables implicit discovery of all transitive package dependencies. + +After the `find_package(FairMQ)` the following CMake variables are defined: + + * `${FairMQ_BOOST_COMPONENTS}` contains the list of Boost components FairMQ depends on. ## Documentation