summaryrefslogtreecommitdiffstats
path: root/cmake/addons/depends/README
diff options
context:
space:
mode:
Diffstat (limited to 'cmake/addons/depends/README')
-rw-r--r--cmake/addons/depends/README35
1 files changed, 3 insertions, 32 deletions
diff --git a/cmake/addons/depends/README b/cmake/addons/depends/README
index 584a167..6fcec8f 100644
--- a/cmake/addons/depends/README
+++ b/cmake/addons/depends/README
@@ -25,37 +25,8 @@ are:
25 * flags.txt: additional build flags 25 * flags.txt: additional build flags
26 * deps.txt: whitespace separated list of dependencies of this dependency 26 * deps.txt: whitespace separated list of dependencies of this dependency
27 27
28The buildsystem uses the following variables (which can be passed into it when 28The buildsystem uses the following depends-related variables (which can be passed
29executing cmake with the -D<variable-name>=<value> option) to e.g. access 29into it when executing cmake with the -D<variable-name>=<value> option) to e.g.
30specific paths: 30access specific paths:
31 * CMAKE_BUILD_TYPE specifies the type of the build. This can be either "Debug"
32 or "Release" (default is "Release").
33 * CMAKE_TOOLCHAIN_FILE can be used to pass a toolchain file into the add-on
34 builds.
35 * CORE_SYSTEM_NAME is the name of the platform (e.g. "linux" or "android") in
36 lower-case (defaults to lowercase(CMAKE_SYSTEM_NAME)).
37 * CORE_SOURCE_DIR points to the root directory of the project (default is the
38 absolute representation of ../../.. starting from this directory).
39 * ADDON_DEPENDS_PATH points to the directory where the built dependencies
40 (their include and library file) will be installed to.
41 * ARCH_DEFINES specifies the platform-specific C/C++ preprocessor defines
42 (defaults to empty).
43 * DEPENDS_TO_BUILD is a quoted, space delimited list of <dependency>s that 31 * DEPENDS_TO_BUILD is a quoted, space delimited list of <dependency>s that
44 you want to build (default is "all"). 32 you want to build (default is "all").
45
46To trigger the cmake-based buildsystem the following command must be executed
47with <path> being the path to this directory (absolute or relative, allowing for
48in-source and out-of-source builds).
49
50 cmake <path> -G <generator>
51
52cmake supports multiple generators, see
53http://www.cmake.org/cmake/help/v2.8.8/cmake.html#section_Generators for a list.
54
55In case of additional options the call might look like this
56
57 cmake <path> [-G <generator>] \
58 -DCMAKE_BUILD_TYPE=Release \
59 -DCORE_SOURCE_DIR="<path-to-project-root>" \
60 -DARCH_DEFINES="-DTARGET_LINUX" \
61 -DCMAKE_INSTALL_PREFIX="<path-to-install-directory"