diff options
Diffstat (limited to 'project/cmake/addons/README.md')
| -rw-r--r-- | project/cmake/addons/README.md | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/project/cmake/addons/README.md b/project/cmake/addons/README.md index c75ead7..6470ee1 100644 --- a/project/cmake/addons/README.md +++ b/project/cmake/addons/README.md | |||
| @@ -31,16 +31,20 @@ The buildsystem uses the following variables (which can be passed into it when e | |||
| 31 | - `ADDONS_DEFINITION_DIR` points to the directory containing the definitions for the addons to be built | 31 | - `ADDONS_DEFINITION_DIR` points to the directory containing the definitions for the addons to be built |
| 32 | - `ADDON_SRC_PREFIX` can be used to override the add-on repository location. It must point to the locally available parent directory of the add-on(s) to build. `<addon-id>` will be appended to this path automatically | 32 | - `ADDON_SRC_PREFIX` can be used to override the add-on repository location. It must point to the locally available parent directory of the add-on(s) to build. `<addon-id>` will be appended to this path automatically |
| 33 | - `CMAKE_BUILD_TYPE` specifies the type of the build. This can be either *Debug* or *Release* (default is *Release*) | 33 | - `CMAKE_BUILD_TYPE` specifies the type of the build. This can be either *Debug* or *Release* (default is *Release*) |
| 34 | - `CMAKE_INSTALL_PREFIX` points to the directory where the built add-ons and their additional files (addon.xml, resources, ...) will be installed to (defaults to `<DEPENDS_PATH>`) | 34 | - `CMAKE_INSTALL_PREFIX` points to the directory where the built add-ons and their additional files (addon.xml, resources, ...) will be installed to (defaults to `<ADDON_DEPENDS_PATH>`) |
| 35 | - `CMAKE_TOOLCHAIN_FILE` can be used to pass a toolchain file into the add-on builds | 35 | - `CMAKE_TOOLCHAIN_FILE` can be used to pass a toolchain file into the add-on builds |
| 36 | - `DEPENDS_PATH` points to the directory containing the *include* and *lib* directories of the add-ons' dependencies. | 36 | - `ADDON_DEPENDS_PATH` points to the directory containing the *include* and *lib* directories of the add-ons' dependencies. |
| 37 | - `APP_ROOT` points to the root directory of the project (default is the absolute representation of ../../.. starting from this directory) | 37 | - `CORE_SOURCE_DIR` points to the root directory of the project (default is the absolute representation of ../../.. starting from this directory) |
| 38 | - `BUILD_DIR` points to the directory where the add-ons and their dependencies will be downloaded and built | 38 | - `BUILD_DIR` points to the directory where the add-ons and their dependencies will be downloaded and built |
| 39 | - `PACKAGE_ZIP=ON` means that the add-ons will be 'packaged' into a common folder, rather than being placed in `<CMAKE_INSTALL_PREFIX>/lib/kodi/addons` and `<CMAKE_INSTALL_PREFIX>/share/kodi/addons` | 39 | - `PACKAGE_ZIP=ON` means that the add-ons will be 'packaged' into a common folder, rather than being placed in `<CMAKE_INSTALL_PREFIX>/lib/kodi/addons` and `<CMAKE_INSTALL_PREFIX>/share/kodi/addons` |
| 40 | - `PACKAGE_DIR` points to the directory where the ZIP archived add-ons will be stored after they have been packaged (defaults to `<BUILD_DIR>/zips`) | 40 | - `PACKAGE_DIR` points to the directory where the ZIP archived add-ons will be stored after they have been packaged (defaults to `<BUILD_DIR>/zips`) |
| 41 | - `ARCH_DEFINES` specifies the platform-specific C/C++ preprocessor defines (defaults to empty) | 41 | - `ARCH_DEFINES` specifies the platform-specific C/C++ preprocessor defines (defaults to empty) |
| 42 | - `ADDON_TARBALL_CACHING` specifies whether downloaded add-on source tarballs should be cached or not (defaults to *ON*) | 42 | - `ADDON_TARBALL_CACHING` specifies whether downloaded add-on source tarballs should be cached or not (defaults to *ON*) |
| 43 | 43 | ||
| 44 | ## Deprecated buildsystem variables | ||
| 45 | Buildsystem will print a warning if you use any of the below-listed variables. For now they still work but you should adapt your workflow to the new variables. | ||
| 46 | - `APP_ROOT` - Use `CORE_SOURCE_DIR` instead | ||
| 47 | |||
| 44 | ## Building | 48 | ## Building |
| 45 | The buildsystem makes some assumptions about the environment which must be met by whoever uses it: | 49 | The buildsystem makes some assumptions about the environment which must be met by whoever uses it: |
| 46 | - Any dependencies of the add-ons must already be built and their include and library files must be present in the path pointed to by `<CMAKE_PREFIX_PATH>` (in *include* and *lib* sub-directories) | 50 | - Any dependencies of the add-ons must already be built and their include and library files must be present in the path pointed to by `<CMAKE_PREFIX_PATH>` (in *include* and *lib* sub-directories) |
| @@ -55,7 +59,7 @@ In case of additional options the call might look like this: | |||
| 55 | 59 | ||
| 56 | cmake `<path>` [-G `<generator>`] \ | 60 | cmake `<path>` [-G `<generator>`] \ |
| 57 | -DCMAKE_BUILD_TYPE=Release \ | 61 | -DCMAKE_BUILD_TYPE=Release \ |
| 58 | -DAPP_ROOT="`<path-to-app-root>`" \ | 62 | -DCORE_SOURCE_DIR="`<path-to-app-root>`" \ |
| 59 | -DARCH_DEFINES="-DTARGET_LINUX" \ | 63 | -DARCH_DEFINES="-DTARGET_LINUX" \ |
| 60 | -DDEPENDS_PATH=`<path-to-built-depends>` \ | 64 | -DADDON_DEPENDS_PATH=`<path-to-built-depends>` \ |
| 61 | -DCMAKE_INSTALL_PREFIX="`<path-to-install-directory`" | 65 | -DCMAKE_INSTALL_PREFIX="`<path-to-install-directory`" |