From af594a79edb2e4b554ee8b61775dd816277d130a Mon Sep 17 00:00:00 2001 From: elijah Date: Thu, 10 Apr 2014 00:42:11 -0700 Subject: update README build instructions to include build-tools, android support, and jdk. --- README.md | 42 ++++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 30f143df..1d3f1dc0 100644 --- a/README.md +++ b/README.md @@ -9,28 +9,46 @@ report any bugs or feature requests and to see the list of known issues. * [See LICENSE file](https://github.com/leapcode/bitmask_android/blob/master/LICENSE.txt) -## Building +## Build Requirements -The build requires the [Android SDK](http://developer.android.com/sdk/index.html) API 17 and the [Android NDK](http://developer.android.com/tools/sdk/ndk/index.html) r9d -to be installed in your development environment. +Install from developer.android.com: -In addition you'll need ant/bin, android/tools, 'platforms-tools' and 'android-ndk-r9d' in your enviroment path. +* Android SDK, API 17: http://developer.android.com/sdk/index.html +* Android NDK, r9d: http://developer.android.com/tools/sdk/ndk/index.html -### Native sources +Make sure add the necessary android tools to your bin path. For example, assuming you installed +the SDK and NDK to `~/dev` on a linux machine, you would add this to your path: + + ~/dev/android-sdk-linux/tools + ~/dev/android-sdk-linux/platform-tools + ~/dev/android-ndk-r9d + +Installable via `android` command (SDK Manager): + +* Android SDK Build-tools, 19.0.1 +* Android Support Repository, 4+ + +Finally, install a java compiler. For example: + + sudo apt-get install default-jdk + +### Build native sources To build NDK sources, you need to issue these commands: -* cd app -* ./build-native.sh -* cd .. (to get back to the project directory) + cd app + ./build-native.sh + cd .. (to get back to the project directory) + +### Compiling from the command line -### Command line + ./gradlew build -* ./gradlew build +The resulting apk(s) will be in `app/build/apk`. -### Android Studio +### Using Android Studio -* Import project => select bitmask_android top folder +* `Import project` => select bitmask_android top folder ## Acknowledgements -- cgit v1.2.3