summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorParménides GV <parmegv@sdf.org>2014-04-10 09:48:13 +0200
committerParménides GV <parmegv@sdf.org>2014-04-10 09:48:13 +0200
commitb2f8436c729a92690e51716bc518173656214e29 (patch)
tree15896382a1a2384f2506d5575c40397ee774fdc7 /README.md
parent1de5aacb1e56f0cfd08b35946a2ccc57f72b7ca1 (diff)
parentaf594a79edb2e4b554ee8b61775dd816277d130a (diff)
Merge remote-tracking branch 'elijah/update-readme' into develop
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files 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