PageRenderTime 32ms CodeModel.GetById 15ms app.highlight 13ms RepoModel.GetById 1ms app.codeStats 0ms

/README.html

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