From 3a690770915528a058fa8e19248ef806c001c5e4 Mon Sep 17 00:00:00 2001 From: "Reece H. Dunn" Date: Tue, 11 Dec 2012 21:25:26 +0000 Subject: [PATCH] README.md: add instructions on how to build and install eSpeak for Android. --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 3d0fb27f..2542eeec 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,36 @@ This branch contains the files needed to build espeak on the android platform. It is derived from the eyes-free project. + +## Prerequisits + +To build eSpeak for Android, you need to have the following installed and +configured correctly: + +1. Android SDK +2. Android NDK +3. Eclipse +4. Android Developer Tools (ADT) for Eclipse + +## Building + +1. Build the `libttsespeak.so` file by running: + + $ ndk-build +2. Open Eclipse. +3. Create a new workspace. +4. Import the espeak folder as an exising Android project. +5. Build the espeak apk within Eclipse. + +## Installing + +The generated `eSpeakActivity.apk` can be installed like any other apk build +via eclipse, such as by using the `Run` menu option. + +After running, `eSpeakActivity` will download the `espeak-data.zip` file. To +enable eSpeak, you need to: + +1. go into the Android `Text-to-Speech settings` UI; +2. enable `eSpeak TTS` in the `Engines` section; +3. select `eSpeak TTS` as the default engine; +4. use the `Listen to an example` option to check if everything is working.