diff --git a/README.md b/README.md index 504d1fa3..ecd528dc 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,11 @@ - [Extended Dictionary Configuration](#extended-dictionary-configuration) - [Testing](#testing) - [Installing](#installing) -- [eSpeak for Android](#espeak-for-android) +- [Android](#android) + - [Dependencies](#dependencies-1) + - [Building with Gradle](#building-with-gradle) + - [Signing the APK](#signing-the-apk) + - [Installing](#installing-1) - [Documentation](#documentation) - [Packaging](#packaging) - [Historical Versions](#historical-versions) @@ -211,11 +215,74 @@ already have an espeak-ng install by running: find /usr/lib | grep libespeak-ng -## eSpeak for Android +## Android -The *android* branch contains the sources for the -[eSpeak for Android](http://reecedunn.co.uk/espeak-for-android) program, based -on the eyes-free port of eSpeak to Android. +
+ +The espeak-ng sources contain the code for the Androidâ„¢ port of the application. +This is published as the [eSpeak for Android](http://reecedunn.co.uk/espeak-for-android) +program on the Google Play store. It is based on the eyes-free port of eSpeak +to the Android platform. This code was originally maintained in a separate +branch when the repository tracked eSpeak releases. + +### Dependencies + +In order to build the Android APK file, you need: + +1. the [Android SDK](http://developer.android.com/sdk/index.html) with API 21 support; +2. the [Android NDK](http://developer.android.com/tools/sdk/ndk/index.html); +3. Gradle 2.1 or later. + +In order to use Android Studio, you will also need: + +1. [Android Studio](http://developer.android.com/sdk/installing/studio.html). + +### Building with Gradle + +1. Set the location of the Android SDK: + + $ export ANDROID_HOME=