diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0820023d5..936d70872 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,6 +44,16 @@ Configuration is available for cmake, [documented elsewhere](https://cmake.org/d Mac support is pretty early and while it will compile, it's not usable for debugging yet. Builds happen with cmake the same way as Linux. +### Android + +To build the components required to debug an Android target, first gather everything from [Dependencies](#dependencies) below, then run: +``` +mkdir build-android +cd build-android +cmake -DBUILD_ANDROID=On -DANDROID_ABI=armeabi-v7a -DANDROID_NATIVE_API_LEVEL=23 .. +make +``` + # Code of Conduct I want to ensure that anyone can contribute to RenderDoc with only the next bug to worry about. For that reason the project has adopted the [contributor covenent](CODE_OF_CONDUCT.md) as a code of conduct to be enforced for anyone taking part in RenderDoc development. If you have any queries in this regard you can get in touch with me [directly over email](mailto:baldurk@baldurk.org). @@ -153,6 +163,42 @@ brew install cmake qt5 brew link qt5 --force ``` +### Android + +To build for Android, you must download components of the Android SDK, the Android NDK, and Java Development Kit. + +If you've already got the tools required, simply set the following three environment variables: +``` +export ANDROID_SDK= +export ANDROID_NDK= +export JAVA_HOME= +``` +Otherwise, below are steps to acquire the tools for Ubuntu. + +The Java Development Kit can be installed with: +``` +sudo apt-get install openjdk-8-jdk +export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64 +``` + +The Android SDK and NDK can be set up with the following steps. They are also mirrored in our Travis-CI [setup script](scripts/travis/android_setup.sh) for Android. We are currently targeting build-tools 26.0.1 and NDK r14b. +``` +# Set up Android SDK and NDK +export ANDROID_SDK= +pushd $ANDROID_SDK +wget http://dl.google.com/android/repository/sdk-tools-linux-3859397.zip +unzip sdk-tools-linux-3859397.zip +cd tools/bin/ +./sdkmanager --sdk_root=$ANDROID_SDK "build-tools;26.0.1" "platforms;android-23" +# Accept the license + +# Set up Android NDK +pushd $ANDROID_SDK +wget http://dl.google.com/android/repository/android-ndk-r14b-linux-x86_64.zip +unzip android-ndk-r14b-linux-x86_64.zip +export ANDROID_NDK=$ANDROID_SDK/android-ndk-r14b +``` + # Where to Start There are always plenty of things to do, if you'd like to chip in! Check out the [Roadmap](https://github.com/baldurk/renderdoc/wiki/Roadmap) page in the wiki for future tasks to tackle, or have a look at the [issues](https://github.com/baldurk/renderdoc/issues) for outstanding bugs. I'll try and tag things that seem like small changes that would be a good way for someone to get started with.