/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. 

  2.                "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
    3. 

  3. <html xmlns="http://www.w3.org/1999/xhtml"
    4. 

  4. lang="en" xml:lang="en">
    5. 

  5. <head>
    6. 

  6. <title>README For Project Eyes-Free</title>
    7. 

  7. <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
    8. 

  8. <meta name="generator" content="Org-mode"/>
    9. 

  9. <meta name="generated" content="2009/04/23 15:09:02"/>
    10. 

  10. <meta name="author" content="T.V Raman and Charles L. Chen"/>
    11. 

  11. <style type="text/css">
    12. 

  12.   html {
    13. 

  13. 	font-family: Times, serif;
    14. 

  14. 	font-size: 12pt;
    15. 

  15.   }
    16. 

  16.   .title { text-align: center; }
    17. 

  17.   .todo  { color: red; }
    18. 

  18.   .done { color: green; }
    19. 

  19.   .timestamp { color: grey }
    20. 

  20.   .timestamp-kwd { color: CadetBlue }
    21. 

  21.   .tag { background-color:lightblue; font-weight:normal }
    22. 

  22.   .target { background-color: lavender; }
    23. 

  23.   pre {
    24. 

  24. 	border: 1pt solid #AEBDCC;
    25. 

  25. 	background-color: #F3F5F7;
    26. 

  26. 	padding: 5pt;
    27. 

  27. 	font-family: courier, monospace;
    28. 

  28.   }
    29. 

  29.   table { border-collapse: collapse; }
    30. 

  30.   td, th {
    31. 

  31. 	vertical-align: top;
    32. 

  32. 	<!--border: 1pt solid #ADB9CC;-->
    33. 

  33.   }
    34. 

  34. </style>
    35. 

  35. </head><body>
    36. 

  36. <h1 class="title">README For Project Eyes-Free</h1>
    37. 

  37. 

  38. <h2>1 Introduction</h2>
    39. 

  39. 

  40. 

  41. <p>
    42. 

  42. This directory contains source code for various eyes-free
    43. 

  43. applications for the Android platform --- see
    44. 

  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,
    45. 

  45. January 4, 2009. It will also contain supporting code and
    46. 

  46. libraries for services such as Text-To-Speech
    47. 

  47. <a href="http://en.wikipedia.org/wiki/Speech_synthesis">(TTS)</a>.
    48. 

  48. </p>
    49. 

  49. <p>
    50. 

  50. <a href="http://www.youtube.com/eyesfreeandroid">For demos of various Eyes-Free projects, please visit our YouTube Channel.</a>
    51. 

  51. </p>
    52. 

  52. <p>
    53. 

  53. Or better yet, go to Android Market on your G1 and try these apps out for
    54. 

  54. yourself.
    55. 

  55. </p>
    56. 

  56. 

  57. <h2>2 Initial Setup</h2>
    58. 

  58. 

  59. 

  60. <ol>
    61. 

  61. <li>
    62. 

  62. <a href="http://developer.android.com/">Download and setup the Android SDK.</a>
    63. 

  63. 

  64. </li>
    65. 

  65. <li>
    66. 

  66. <a href="http://code.google.com/p/eyes-free/source/checkout">Checkout the source code for the Eyes-Free project.</a>
    67. 

  67. 

  68. </li>
    69. 

  69. <li>
    70. 

  70. If you are building with Eclipse:
    71. 

  71. <ul>
    72. 

  72. <li>
    73. 

  73. File &gt; Import &gt; General &gt; Existing Projects into Workspace.
    74. 

  74. </li>
    75. 

  75. <li>
    76. 

  76. With "Select root directory:" selected, browse to the root of your SVN
    77. 

  77. directory.
    78. 

  78. </li>
    79. 

  79. <li>
    80. 

  80. Select the Eyes-Free projects you wish to import into your Workspace.
    81. 

  81. </li>
    82. 

  82. <li>
    83. 

  83. Click Finish.
    84. 

  84. </li>
    85. 

  85. <li>
    86. 

  86. For each of the projects, right click, Properties &gt; Java Build Path &gt;
    87. 

  87. Libraries and then fix any broken paths by pointing them at the
    88. 

  88. "commonlibs" directory.
    89. 

  89. 

  90. </li>
    91. 

  91. </ul>If you are building with Ant:
    92. 

  92. <ul>
    93. 

  93. <li>
    94. 

  94. Go to the "tools" subdirectory of the Android SDK.
    95. 

  95. </li>
    96. 

  96. <li>
    97. 

  97. For each project you wish to build, run this command:
    98. 

  98. <pre>
    99. 

  99. android update project --path /path/to/fooproject --target 1
    100. 

  100. </pre>
    101. 

  101. 

  102. 

  103. 

  104. </li>
    105. 

  105. </ul></li>
    106. 

  106. </ol>
    107. 

  107. 

  108. <h2>3 Build Instructions</h2>
    109. 

  109. 

  110. 

  111. <p>
    112. 

  112. If you are building with Eclipse:
    113. 

  113. These projects are built like any other Android project. Hit the run button,
    114. 

  114. choose "Android Application" in the "Run As" screen, and you're done.
    115. 

  115. </p>
    116. 

  116. <p>
    117. 

  117. If you are building with Ant:
    118. 

  118. Each of these eyes-free applications can be built with a simple command-line
    119. 

  119. of the form:
    120. 

  120. </p>
    121. 

  121. <p>
    122. 

  122. <pre>
    123. 

  123. ant &lt;build type&gt;
    124. 

  124. </pre>
    125. 

  125. </p>
    126. 

  126. <p>
    127. 

  127. where &lt;build type&gt; is "debug", "release", "install", "reinstall", or 
    128. 

  128. "uninstall" without quotes.
    129. 

  129. </p>
    130. 

  130. <p>
    131. 

  131. The most common types are "reinstall" (build with debug key and automatically
    132. 

  132. install on your device/emulator, overwriting any older version that may exist)
    133. 

  133. and "release" (build an unsigned apk which you can sign with your own key and
    134. 

  134. put on Market).
    135. 

  135. </p>
    136. 

  136. <p>
    137. 

  137. Thus, to build the Talking Dialer and automatically install it, 
    138. 

  138. <pre>
    139. 

  139.  cd talkingdialer
    140. 

  140.  ant reinstall
    141. 

  141. </pre>
    142. 

  142. </p>
    143. 

  143. 

  144. 

  145. <h2>4 List Of Eyes-Free Applications</h2>
    146. 

  146. 

  147. 

  148. <p>
    149. 

  149. Each application is found in its own sub-directory.
    150. 

  150. </p>
    151. 

  151. <table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
    152. 

  152. <COL align="left"><COL align="left"><COL align="left">
    153. 

  153. <thead>
    154. 

  154. <tr><th>Name</th><th>Description</th><th>Directory</th></tr>
    155. 

  155. </thead>
    156. 

  156. <tbody>
    157. 

  157. <tr><td>mem</td><td>The Android Memory Game</td><td>androidsays</td></tr>
    158. 

  158. <tr><td>Brailler</td><td>Demo of using the touchscreen for Braille input</td><td>brailler</td></tr>
    159. 

  159. <tr><td>Common Library</td><td>Jars used by all applications</td><td>commonlibs</td></tr>
    160. 

  160. <tr><td>Compass</td><td>Talking Compass</td><td>compass</td></tr>
    161. 

  161. <tr><td>Eyes-Free Config</td><td>Configuration manager for the Eyes-Free suite of applications</td><td>config</td></tr>
    162. 

  162. <tr><td>Documentation</td><td>The documentation directory - contains example apps</td><td>documentation</td></tr>
    163. 

  163. <tr><td>Native Code</td><td>The native code for the text-to-speech service</td><td>native</td></tr>
    164. 

  164. <tr><td>Randroid</td><td>Random xkcd comic viewer that can read the comic aloud</td><td>randroid</td></tr>
    165. 

  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. 

  166. <tr><td>Eyes-Free Shell</td><td>Alternative eyes-free homescreen</td><td>shell</td></tr>
    167. 

  167. <tr><td>Slide Text</td><td>Demo of using stroke dialer for text entry</td><td>slidetext</td></tr>
    168. 

  168. <tr><td>Talking Dialer</td><td>Talking dialer app that uses stroke dialing for eyes-free use</td><td>talkingdialer</td></tr>
    169. 

  169. <tr><td>There</td><td>Location marking/way finding app</td><td>there</td></tr>
    170. 

  170. <tr><td>Third Party</td><td>Third Party Code and Data</td><td>thirdparty</td></tr>
    171. 

  171. <tr><td>Text-To-Speech Service</td><td>The text-to-speech service that generates synthesized speech</td><td>tts</td></tr>
    172. 

  172. <tr><td>Utility Classes</td><td>Useful Java utility classes that can be reused by multiple projects</td><td>utils</td></tr>
    173. 

  173. <tr><td>WhereAbout</td><td>Local information app</td><td>whereabout</td></tr>
    174. 

  174. </tbody>
    175. 

  175. </table>
    176. 

  176. 

  177. 

  178. <p class="author"> Author: T.V Raman and Charles L. Chen
    179. 

  179. <a href="mailto:raman@google.com">&lt;raman@google.com&gt;</a>
    180. 

  180. </p>
    181. 

  181. <p class="date"> Date: 2009/04/23 15:09:02</p>
    182. 

  182. </body>
    183. 

  183. </html>
    184.