diff options
Diffstat (limited to 'cmake/README.md')
| -rw-r--r-- | cmake/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/cmake/README.md b/cmake/README.md index 8637da6..2febe48 100644 --- a/cmake/README.md +++ b/cmake/README.md | |||
| @@ -21,6 +21,26 @@ cmake ... -DENABLE_VAAPI=ON -DENABLE_VDPAU=OFF ... | |||
| 21 | 21 | ||
| 22 | Unfortunately, Kodi's CMake gazillion options are not fully documented yet. For more information and an updated list of options, please check the main **[CMakeLists.txt](../CMakeLists.txt)**. | 22 | Unfortunately, Kodi's CMake gazillion options are not fully documented yet. For more information and an updated list of options, please check the main **[CMakeLists.txt](../CMakeLists.txt)**. |
| 23 | 23 | ||
| 24 | ## Buildsystem variables | ||
| 25 | The buildsystem uses the following variables (which can be passed into it when executing cmake with the -D`<variable-name>=<value>` format) to manipulate the build process (see READMEs in sub-directories for additional variables): | ||
| 26 | - `CMAKE_BUILD_TYPE` specifies the type of the build. This can be either *Debug* or *Release* (default is *Release*) | ||
| 27 | - `CMAKE_TOOLCHAIN_FILE` can be used to pass a toolchain file | ||
| 28 | - `ARCH_DEFINES` specifies the platform-specific C/C++ preprocessor defines (defaults to empty) | ||
| 29 | |||
| 30 | ## Building | ||
| 31 | To trigger the cmake-based buildsystem the following command must be executed with `<path>` set to this directory (absolute or relative) allowing for in-source and out-of-source builds | ||
| 32 | |||
| 33 | `cmake <path> -G <generator>` | ||
| 34 | |||
| 35 | CMake supports multiple generators. See [here] (https://cmake.org/cmake/help/v3.1/manual/cmake-generators.7.html) for a list. | ||
| 36 | |||
| 37 | In case of additional options the call might look like this: | ||
| 38 | |||
| 39 | cmake `<path>` [-G `<generator>`] \ | ||
| 40 | -DCMAKE_BUILD_TYPE=Release \ | ||
| 41 | -DARCH_DEFINES="-DTARGET_LINUX" \ | ||
| 42 | -DCMAKE_INSTALL_PREFIX="`<path-to-install-directory`" | ||
| 43 | |||
| 24 | ## Tests | 44 | ## Tests |
| 25 | Kodi uses Google Test as its testing framework. Each test file is scanned for tests and these are added to CTest, which is the native test driver for CMake. | 45 | Kodi uses Google Test as its testing framework. Each test file is scanned for tests and these are added to CTest, which is the native test driver for CMake. |
| 26 | 46 | ||
