-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.html
183 lines (162 loc) · 5.85 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
lang="en" xml:lang="en">
<head>
<title>README For Project Eyes-Free</title>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
<meta name="generator" content="Org-mode"/>
<meta name="generated" content="2009/04/23 15:09:02"/>
<meta name="author" content="T.V Raman and Charles L. Chen"/>
<style type="text/css">
html {
font-family: Times, serif;
font-size: 12pt;
}
.title { text-align: center; }
.todo { color: red; }
.done { color: green; }
.timestamp { color: grey }
.timestamp-kwd { color: CadetBlue }
.tag { background-color:lightblue; font-weight:normal }
.target { background-color: lavender; }
pre {
border: 1pt solid #AEBDCC;
background-color: #F3F5F7;
padding: 5pt;
font-family: courier, monospace;
}
table { border-collapse: collapse; }
td, th {
vertical-align: top;
<!--border: 1pt solid #ADB9CC;-->
}
</style>
</head><body>
<h1 class="title">README For Project Eyes-Free</h1>
<h2>1 Introduction</h2>
<p>
This directory contains source code for various eyes-free
applications for the Android platform --- see
<a href="http://www.nytimes.com/2009/01/04/business/04blind.html?pagewanted=1&_r=1&ref=business">For The Blind, Technology Does What A Guide Dog Can't</a>, NYTimes,
January 4, 2009. It will also contain supporting code and
libraries for services such as Text-To-Speech
<a href="http://en.wikipedia.org/wiki/Speech_synthesis">(TTS)</a>.
</p>
<p>
<a href="http://www.youtube.com/eyesfreeandroid">For demos of various Eyes-Free projects, please visit our YouTube Channel.</a>
</p>
<p>
Or better yet, go to Android Market on your G1 and try these apps out for
yourself.
</p>
<h2>2 Initial Setup</h2>
<ol>
<li>
<a href="http://developer.android.com/">Download and setup the Android SDK.</a>
</li>
<li>
<a href="http://code.google.com/p/eyes-free/source/checkout">Checkout the source code for the Eyes-Free project.</a>
</li>
<li>
If you are building with Eclipse:
<ul>
<li>
File > Import > General > Existing Projects into Workspace.
</li>
<li>
With "Select root directory:" selected, browse to the root of your SVN
directory.
</li>
<li>
Select the Eyes-Free projects you wish to import into your Workspace.
</li>
<li>
Click Finish.
</li>
<li>
For each of the projects, right click, Properties > Java Build Path >
Libraries and then fix any broken paths by pointing them at the
"commonlibs" directory.
</li>
</ul>If you are building with Ant:
<ul>
<li>
Go to the "tools" subdirectory of the Android SDK.
</li>
<li>
For each project you wish to build, run this command:
<pre>
android update project --path /path/to/fooproject --target 1
</pre>
</li>
</ul></li>
</ol>
<h2>3 Build Instructions</h2>
<p>
If you are building with Eclipse:
These projects are built like any other Android project. Hit the run button,
choose "Android Application" in the "Run As" screen, and you're done.
</p>
<p>
If you are building with Ant:
Each of these eyes-free applications can be built with a simple command-line
of the form:
</p>
<p>
<pre>
ant <build type>
</pre>
</p>
<p>
where <build type> is "debug", "release", "install", "reinstall", or
"uninstall" without quotes.
</p>
<p>
The most common types are "reinstall" (build with debug key and automatically
install on your device/emulator, overwriting any older version that may exist)
and "release" (build an unsigned apk which you can sign with your own key and
put on Market).
</p>
<p>
Thus, to build the Talking Dialer and automatically install it,
<pre>
cd talkingdialer
ant reinstall
</pre>
</p>
<h2>4 List Of Eyes-Free Applications</h2>
<p>
Each application is found in its own sub-directory.
</p>
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
<COL align="left"><COL align="left"><COL align="left">
<thead>
<tr><th>Name</th><th>Description</th><th>Directory</th></tr>
</thead>
<tbody>
<tr><td>mem</td><td>The Android Memory Game</td><td>androidsays</td></tr>
<tr><td>Brailler</td><td>Demo of using the touchscreen for Braille input</td><td>brailler</td></tr>
<tr><td>Common Library</td><td>Jars used by all applications</td><td>commonlibs</td></tr>
<tr><td>Compass</td><td>Talking Compass</td><td>compass</td></tr>
<tr><td>Eyes-Free Config</td><td>Configuration manager for the Eyes-Free suite of applications</td><td>config</td></tr>
<tr><td>Documentation</td><td>The documentation directory - contains example apps</td><td>documentation</td></tr>
<tr><td>Native Code</td><td>The native code for the text-to-speech service</td><td>native</td></tr>
<tr><td>Randroid</td><td>Random xkcd comic viewer that can read the comic aloud</td><td>randroid</td></tr>
<tr><td>Remind Me</td><td>Talking alarm that uses stroke dialer input to set the time and the user's own voice note for the alarm</td><td>remindme</td></tr>
<tr><td>Eyes-Free Shell</td><td>Alternative eyes-free homescreen</td><td>shell</td></tr>
<tr><td>Slide Text</td><td>Demo of using stroke dialer for text entry</td><td>slidetext</td></tr>
<tr><td>Talking Dialer</td><td>Talking dialer app that uses stroke dialing for eyes-free use</td><td>talkingdialer</td></tr>
<tr><td>There</td><td>Location marking/way finding app</td><td>there</td></tr>
<tr><td>Third Party</td><td>Third Party Code and Data</td><td>thirdparty</td></tr>
<tr><td>Text-To-Speech Service</td><td>The text-to-speech service that generates synthesized speech</td><td>tts</td></tr>
<tr><td>Utility Classes</td><td>Useful Java utility classes that can be reused by multiple projects</td><td>utils</td></tr>
<tr><td>WhereAbout</td><td>Local information app</td><td>whereabout</td></tr>
</tbody>
</table>
<p class="author"> Author: T.V Raman and Charles L. Chen
<a href="mailto:raman@google.com"><raman@google.com></a>
</p>
<p class="date"> Date: 2009/04/23 15:09:02</p>
</body>
</html>