<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.3.9: http://docutils.sourceforge.net/" />
<title>README for SpeechLion 0.3.2</title>
<link rel="stylesheet" href="default.css" type="text/css" />
</head>
<body>
<div class="document" id="readme-for-speechlion-0-3-2">
<h1 class="title">README for SpeechLion 0.3.2</h1>
<div class="section" id="summary">
<h1><a name="summary">Summary</a></h1>
<p>SpeechLion is a small speech recognition application
based on <a class="reference" href="http://cmusphinx.sf.net/sphinx4">Sphinx-4</a> which demonstrates desktop command
and control.</p>
<p>Currently it is mainly useful for assistance when web-browsing and can
save a lot of keyboard and mouse usage. It also has a small Emacs
mode and a Unix shell mode. It is developed and tested under Linux and
Gnome. The engine runs entirely on the Java VM, and
should easily run under Windows.
The grammar files (which control most of the features) are dependent
on the keyboard shortcuts used by the Mozilla family of browsers under
Linux. It is tested with Firefox.</p>
<p>SpeechLion is alpha-quality code. It is basically
a proof of concept right now. It does some useful
things for me and is at a point where others may enjoy it
too.</p>
</div>
<div class="section" id="features">
<h1><a name="features">Features</a></h1>
<ul class="simple">
<li>Web browsing shortcuts</li>
<li>Emacs shortcuts</li>
<li>Shell shortcuts</li>
<li>Window management shortcuts</li>
<li>Volume and muting commands</li>
<li>ssh commands</li>
<li>Command mode, spelling mode, mousing mode, and off mode</li>
<li>Low-level keyboard input for most possible keyboard combinations</li>
<li>Low-level mouse input for motion, button presses, and wheel movement</li>
<li>Repeat command</li>
<li>With optional <a class="reference" href="http://freetts.sf.net">FreeTTS</a> library, provides spoken acknowledgements
of commands</li>
</ul>
</div>
<div class="section" id="requirements">
<h1><a name="requirements">Requirements</a></h1>
<p>SpeechLion requires the following software to run:</p>
<ul class="simple">
<li>Java runtime environment 1.5 or greater</li>
<li>Jython 2.1 or greater</li>
<li><a class="reference" href="http://cmusphinx.sf.net/sphinx4">Sphinx-4</a> 1.0beta binary distro or newer</li>
<li>Optional: <a class="reference" href="http://freetts.sf.net">FreeTTS</a> 1.2.1 binary distro or newer</li>
</ul>
<p>The keyboard shortcuts are tested on a Linux Gnome environment
with the Firefox web browser.</p>
</div>
<div class="section" id="usage">
<h1><a name="usage">Usage</a></h1>
<p>Detailed installation instructions are provided in the INSTALL file.
Usage instructions are provided in the USAGE file. HTML-formatted
versions of all the documents are located in the <tt class="docutils literal"><span class="pre">html</span></tt> directory.
Start with <tt class="docutils literal"><span class="pre">html/index.html</span></tt>.</p>
</div>
<div class="section" id="license">
<h1><a name="license">License</a></h1>
<p>SpeechLion is licensed under the GNU General Public License (GPL).
See the COPYING file for details.</p>
</div>
<div class="section" id="author">
<h1><a name="author">Author</a></h1>
<p>SpeechLion is written by Robert W. Brewer, rwb123 at gmail dot com.
Comments, questions, and enhancements are welcome.</p>
</div>
</div>
<div class="footer">
<hr class="footer" />
Generated on: 2006-02-01.
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>
</body>
</html>