=================
INSTALL
=================

Requirements
=============

SpeechLion requires the following software packages to
run:

+ Java_ runtime environment 1.5 or greater
+ Jython_ 2.1 or greater
+ Sphinx-4_ 1.0beta or newer
+ Optional: FreeTTS_ 1.2.1 binary or greater


Install Java_ 1.5 SDK
======================

Sphinx-4 is written in Java and therefore requires the JVM
to run.  To install Java on Debian Linux, this requires the following::

  apt-get install java-package

Read the man page for ``make-jpkg``.  Download
the Java 1.5 SDK from http://java.sun.com
Next::
  
  make-jpkg j2se-file

This creates a .deb file which can be installed::

  dpkg -i sun-j2sdk...deb

Install Jython_ 2.1
====================

SpeechLion is written in Jython.  This is the Python programming
language running on top of the JVM.  It is excellent for scripting
Java programs and rapid development.

Download ``jython-21.class`` from SourceForge.  This is in the
Download section of the Jython_ site.  Next::

  export CLASSPATH=$CLASSPATH:.
  java jython-21

If more detail is needed, see the `Jython install instructions`__.

__ http://www.jython.org/install.html


Install Sphinx-4_ 1.0beta binary
================================

See the `Sphinx-4 download instructions`__ for more details.

__ http://cmusphinx.sf.net/sphinx4/#download_and_install

Download the Sphinx-4 1.0beta binary package from SourceForge
and unpack it.  Next::

  cd sphinx4/lib
  chmod +x jsapi.sh
  sh ./jsapi.sh

Now accept the BCL which will unpack ``jsapi.jar``.


Optional: Install FreeTTS_ 1.2.1 binary
=======================================

FreeTTS is used to provide spoken acknowledgement of speech input.
See the `FreeTTS download instructios`__ for more details on
installing FreeTTS.

__ http://freetts.sourceforge.net/docs/index.php#download_and_install

Download the FreeTTS 1.2.1 binary package from SourceForge and unpack
it.  Next::

  cd lib
  chmod +x jsapi.sh
  sh ./jsapi.sh

Now accept the BCL which will unpack ``jsapi.jar``.


Configure SpeechLion Paths
===========================

The ``speechlion`` script is just a modified version of the ``jython``
script installed by Jython.  Simply modify ``speechlion`` so that
``SPHINX4`` points to your Sphinx-4 installation, ``FREETTS``
points to your FreeTTS installation, and the last
line points to your Java and Jython installations.

If you don't have FreeTTS installed, this should be detected
automatically when SpeechLion starts and a message
will be printed.  


Run SpeechLion
===============

If everything is built and installed correctly, try running
SpeechLion from its directory::

  ./speechlion

If nothing crashes, you can now start speaking commands to 
it.  Try putting your mouse pointer over your Firefox window
and say "browse google".

Now read the documentation in the USAGE file.


.. _Java:     http://java.sun.com
.. _Jython:   http://www.jython.org
.. _Sphinx-4: http://cmusphinx.sf.net/sphinx4
.. _FreeTTS:  http://freetts.sf.net