/README

 1#    -*- mode: org -*-
 2
 3* Introduction
 4
 5This directory contains source code for various eyes-free
 6applications for the Android platform --- see
 7[[http://www.nytimes.com/2009/01/04/business/04blind.html?pagewanted=1&_r=1&ref=business][For
 8The Blind, Technology Does What A Guide Dog Can't]], NYTimes,
 9January 4, 2009. It will also contain supporting code and
10libraries for services such as Text-To-Speech
11[[http://en.wikipedia.org/wiki/Speech_synthesis][(TTS)]].
12
13[[http://www.youtube.com/eyesfreeandroid][For demos of various Eyes-Free 
14projects, please visit our YouTube Channel.]]
15
16Or better yet, go to Android Market on your G1 and try these apps out for
17yourself.
18
19* Initial Setup
20
211. [[http://developer.android.com/][Download and setup the Android SDK.]]
22
232. [[http://code.google.com/p/eyes-free/source/checkout][Checkout the source 
24   code for the Eyes-Free project.]]
25
263. If you are building with Eclipse:
27   - File > Import > General > Existing Projects into Workspace.
28   - With "Select root directory:" selected, browse to the root of your SVN
29     directory.
30   - Select the Eyes-Free projects you wish to import into your Workspace.
31   - Click Finish.
32   - For each of the projects, right click, Properties > Java Build Path >
33     Libraries and then fix any broken paths by pointing them at the
34     "commonlibs" directory.
35
36   If you are building with Ant:
37   - Go to the "tools" subdirectory of the Android SDK.
38   - For each project you wish to build, run this command:
39     :android update project --path /path/to/fooproject --target 1
40
41
42
43* Build Instructions
44
45If you are building with Eclipse:
46These projects are built like any other Android project. Hit the run button,
47choose "Android Application" in the "Run As" screen, and you're done.
48
49If you are building with Ant:
50Each of these eyes-free applications can be built with a simple command-line
51of the form:
52
53:ant <build type>
54
55where <build type> is "debug", "release", "install", "reinstall", or 
56"uninstall" without quotes.
57
58The most common types are "reinstall" (build with debug key and automatically
59install on your device/emulator, overwriting any older version that may exist)
60and "release" (build an unsigned apk which you can sign with your own key and
61put on Market).
62
63Thus, to build the Talking Dialer and automatically install it, 
64: cd talkingdialer
65: ant reinstall
66
67
68* List Of Eyes-Free Applications
69
70Each application is found in its own sub-directory.
71
72| Name           | Description                       | Directory     |
73|----------------+-----------------------------------+---------------|
74| mem            | The Android Memory Game           | androidsays   |
75| Brailler       | Demo of using the touchscreen for Braille input           | brailler   |
76| Common Library | Jars used by all applications     | commonlibs    |
77| Compass        | Talking Compass                   | compass       |
78| Eyes-Free Config  | Configuration manager for the Eyes-Free suite of applications  | config   |
79| Documentation            | The documentation directory - contains example apps   | documentation   |
80| Native Code            | The native code for the text-to-speech service   | native   |
81| Randroid            | Random xkcd comic viewer that can read the comic aloud        | randroid   |
82| Remind Me            | Talking alarm that uses stroke dialer input to set the time and the user's own voice note for the alarm | remindme   |
83| Eyes-Free Shell            | Alternative eyes-free homescreen  | shell   |
84| Slide Text            | Demo of using stroke dialer for text entry   | slidetext   |
85| Talking Dialer            | Talking dialer app that uses stroke dialing for eyes-free use   | talkingdialer   |
86| There            | Location marking/way finding app       | there   |
87| Third Party    | Third Party Code and Data                  | thirdparty    |
88| Text-To-Speech Service            | The text-to-speech service that generates synthesized speech  | tts   |
89| Utility Classes            | Useful Java utility classes that can be reused by multiple projects    | utils   |
90| WhereAbout            | Local information app     | whereabout   |
91|----------------+-----------------------------------+---------------|
92
93#+TITLE:     README For Project Eyes-Free
94#+AUTHOR:    T.V Raman and Charles L. Chen
95#+EMAIL:     raman@google.com
96#+DATE:      2009-04-23 Thu
97#+LANGUAGE:  en
98#+OPTIONS:   H:3 num:t toc:nil \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:nil skip:nil d:nil tags:not-in-toc
99#+LINK_HOME:  http://eyes-free.googlecode.com