From ffca21f2743a7b367fa212799c6e2fea6190dd5d Mon Sep 17 00:00:00 2001 From: manuel Date: Tue, 3 Mar 2015 16:53:59 +0100 Subject: initial commit for kodi master --- project/cmake/addons/README | 68 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 project/cmake/addons/README (limited to 'project/cmake/addons/README') diff --git a/project/cmake/addons/README b/project/cmake/addons/README new file mode 100644 index 0000000..c66e668 --- /dev/null +++ b/project/cmake/addons/README @@ -0,0 +1,68 @@ +KODI ADDONS +=========== +This directory contains the cmake-based buildsystem for addons. It looks into +the "addons" sub-directory and parses all *.txt files recursively. Each addon +must have its own .txt file in a separate sub-directory which must +follow the defined format: + +where + * must be identical to the addon's ID as defined in the addon's + addon.xml + * must be the URL of the git repository containing the addon. + * must be a valid git tag/branch/commit in the addon's git + repository which will be used for the build. + +Reserved filenames (for additional information on how to build an addon) +are: + * platforms.txt: List of platforms to build an addon for (or "all"). It is + also supported to specify negated platforms with a leading exclamation mark + (i), e.g. "!windows". + Available platforms are: linux, windows, darwin, ios, android, rbpi + +The buildsystem uses the following variables (which can be passed into it when +executing cmake with the -D= option) to e.g. access +specific paths: + * ADDONS_TO_BUILD is a quoted, space delimited list of s that + you want to build (default is "all"). + * CMAKE_BUILD_TYPE specifies the type of the build. This can be either "Debug" + or "Release" (default is "Release"). + * CMAKE_INSTALL_PREFIX points to the directory where the built addons and their + additional files (addon.xml, resources ...) will be installed to (defaults + to ). + * CMAKE_TOOLCHAIN_FILE can be used to pass a toolchain file into the add-on + builds. + * DEPENDS_PATH points to the directory containing the "include" and "lib" + directories of the addons' dependencies. + * APP_ROOT points to the root directory of the project (default is the + absolute representation of ../../.. starting from this directory). + * BUILD_DIR points to the directory where the addons and their dependencies + will be downloaded and built. + * PACKAGE_ZIP=1 will mean the add-ons will be 'packaged' into a common folder, + rather than being placed in /lib/kodi/addons and + /share/kodi/addons. + * ARCH_DEFINES specifies the platform-specific C/C++ preprocessor defines + (defaults to empty). + +The buildsystem makes some assumptions about the environment which must be met +by whoever uses it: + * Any dependencies of the addons must already be built and their include and + library files must be present in the path pointed to by (in + "include" and "lib" sub-directories). + +To trigger the cmake-based buildsystem the following command must be executed +with being the path to this directory (absolute or relative, allowing for +in-source and out-of-source builds). + + cmake -G + +cmake supports multiple generators, see +http://www.cmake.org/cmake/help/v2.8.8/cmake.html#section_Generators for a list. + +In case of additional options the call might look like this + + cmake [-G ] \ + -DCMAKE_BUILD_TYPE=Release \ + -DAPP_ROOT="" \ + -DARCH_DEFINES="-DTARGET_LINUX" \ + -DDEPENDS_PATH="" \ + -DCMAKE_INSTALL_PREFIX="