diff --git a/depends/README.md b/depends/README.md --- a/depends/README.md +++ b/depends/README.md @@ -38,28 +38,7 @@ cmake -GNinja .. -DCMAKE_TOOLCHAIN_FILE=../cmake/platforms/OSX.cmake ninja -The paths are automatically configured and no other options are needed unless -targeting Android. Before proceeding with an Android build one needs to get the -[Android SDK](https://developer.android.com/studio) and use the "SDK Manager" -tool to download the NDK and one or more "Platform packages" (these are Android -versions and have a corresponding API level). - -In order to build `ANDROID_API_LEVEL` (API level corresponding to the Android -version targeted, e.g. Android 9.0 Pie is 28 and its "Platform package" needs to -be available) and `ANDROID_TOOLCHAIN_BIN` (path to toolchain binaries depending -on the platform the build is being performed on) need to be set. If the build -includes Qt, environment variables `ANDROID_SDK` and `ANDROID_NDK`need to be set -as well but can otherwise be omitted. - -This is an example command for a default build with no disabled dependencies -(the paths needs to be adapted to match your installation): - - export ANDROID_SDK=${HOME}/Android/Sdk - export ANDROID_NDK=${ANDROID_SDK}/ndk-bundle - export ANDROID_TOOLCHAIN_BIN=${ANDROID_NDK}/toolchains/llvm/prebuilt/linux-x86_64/bin - export ANDROID_API_LEVEL=28 - make build-android-aarch64 - +The paths are automatically configured and no other options are needed unless targeting [Android](#Android). ### Install the required dependencies: Ubuntu & Debian @@ -134,6 +113,32 @@ download-linux: run 'make download-linux' to fetch all sources needed for linux builds build-all: build the dependencies for all the arch/OS +### Android + +Before proceeding with an Android build one needs to get the +[Android SDK](https://developer.android.com/studio) and use the "SDK Manager" +tool to download the NDK and one or more "Platform packages" (these are Android +versions and have a corresponding API level). + +In order to build `ANDROID_API_LEVEL` (API level corresponding to the Android +version targeted, e.g. Android 9.0 Pie is 28 and its "Platform package" needs to +be available) and `ANDROID_TOOLCHAIN_BIN` (path to toolchain binaries depending +on the platform the build is being performed on) need to be set. + +API levels from 24 to 29 have been tested to work. + +If the build includes Qt, environment variables `ANDROID_SDK` and `ANDROID_NDK`need to be set +as well but can otherwise be omitted. + +This is an example command for a default build with no disabled dependencies +(the paths needs to be adapted to match your installation): + + export ANDROID_SDK=${HOME}/Android/Sdk + export ANDROID_NDK=${ANDROID_SDK}/ndk-bundle + export ANDROID_TOOLCHAIN_BIN=${ANDROID_NDK}/toolchains/llvm/prebuilt/linux-x86_64/bin + export ANDROID_API_LEVEL=28 + make build-android-aarch64 + ### Other documentation - [description.md](description.md): General description of the depends system