-The `android` module provides support for the Android platform
+Android platform support and APIs
# Compilation for Android
# Host system configuration
-To compile for Android, you must install the Android SDK and NDK.
-The tools `android`, `ndk-build` and `ant` must be in your PATH.
+Some configuration is required to compile for the Android platform from a GNU/Linux host.
+
+1. Download and install the latest Android SDK __and__ NDK.
+
+2. Update PATH so it includes the tools `android`, `ndk-build` and `ant`.
+ You should add something like the following snippet to your .bashrc or equivalent,
+ be careful to replace `ANDROID_SDK` and `ANDROID_NDK` with the full path where you installed each package.
+
+ ~~~
+ export PATH=$PATH:ANDROID_SDK/tools/:ANDROID_SDK/platform-tools/:ANDROID_NDK/
+ ~~~
+
+2. Using the `android` executable, download the latest `tools, build-tools` and within the Android 4.0.3 (API 15) folder, install `SDK platform`.
+ You may have to install additional SDK platforms for applications with different targets.
+
+3. Using your OS package manager, install `apt openjdk-7-jdk lib32stdc++6 lib32z1`.
+ On Debian and Ubuntu the command is:
+
+ ~~~
+ sudo apt-get install apt openjdk-7-jdk lib32stdc++6 lib32z1
+ ~~~
# Configure your Android application
See http://developer.android.com/guide/topics/manifest/uses-sdk-element.html
* The annotation `android_activity` defines a Java class used as an
- entrypoint to your application. As of now, this annotation should
- only be used by low level implementations of Nit on Android.
- It's usefulness will be extended in the future to customize user applications.
+ entry point to your application. As of now, this annotation should
+ only be used by low-level implementations of Nit on Android.
+ Its usefulness will be extended in the future to customize user applications.
+
+## Android implementation
+
+There is two core implementation for Nit apps on Android.
+`android::nit_activity` is used by apps with standard windows and native UI controls.
+`android::game` is used by, well, games and the game frameworks `mnit` and `gamnit`.
+
+Clients don't have to select the core implementation, it is imported by other relevant modules.
+For example, a module importing `app::ui` and `android` will trigger the importation of `android::nit_activity`.
-## Project entry points
+## Lock app orientation
Importing `android::landscape` or `android::portrait` locks the generated
application in the specified orientation. This can be useful for games and
optionally `TSA_SERVER`. These settings can be set in a startup script such as
`~/.bashrc` or in a local Makefile.
- You can use the following commands by replacing the right hand values
+ You can use the following commands by replacing the right-hand values
to your own configuration.
~~~