# file AAREADME.text for isip_r02_n00
# January 29, 2007

Quick Start:

To install the ISIP production system, after unpacking use

      configure [--prefix=/<install directory>]
      make depend
      make install
      make test

(Note: if you use the --prefix option, it must contain a leading
"/" and be an absolute path name.)

After you have installed, you can establish the ISIP environment
(or re-establish it in later sessions) by using the source command:

source <install directory>/ISIP_BASE_ENV.sh

or
cd <install directory>
source ISIP_BASE_ENV.sh

Description:
------------

The Institute for Signal and Information Processing at Mississippi
State University is pleased to release r02_n00 of our C++ foundation
classes (IFCs). This package is under a public-domain license shown at
the bottom of this file.

The major new features in this release are:

 1) Word-internal training;
 2) Network-builder GUI tool for language modeling.
 3) Stream-based speech input;
 4) Efficiency improvements;
 5) Minor bug fixes.

Prerequisites:
-------------

The base system depends on the GNU C++ compiler, g++, and on the GNU make
program.  You must have at least version 4.1.x of g++, and version 3.78.x 
of GNU make for the system to install.  Other versions may work, but 
these are the versions we support.  These programs are available at 
http://www.gnu.org.

The utilities in the package will not run without perl.  You should 
have at least version 5.x.  Perl is available at http://www.perl.com.

The graphical interface to the package requires tcl/tk version 8.x.
Tcl/tk is available from http://dev.scriptics.com.

The Java platform (J2SE 1.3 or higher) is required for some utilities 
in this package. Java is available at http://java.sun.com.

The system has been generated on SunOS 5.7 (Solaris 2.7) for i386
hardware.  It has also been installed on RedHat Linux 9.0. It may also
run in other environments.

Hardware requirements.  We recommend the system with a minimum of 256
megabytes RAM, 512 megabytes swap, and a processor running at a
minimum 500 megaHertz.  More RAM and faster processors will build the
libraries faster.

Details:
--------

First, download the tarfile, unzip it, and extract the files.  The 
directory where these sources are kept can be different from the
directory where the executable programs are installed.

1.  Run configure.  Optionally, you may specify the directory where
    the executables will be installed by using the --prefix option.
    The default install directory is .
    If you type "configure" and the system responds "command not
    found," then type "./configure" instead.  
    ****************************************************************
    If any required modules are not found, you will receive warning 
    messages and will not be allowed to proceed.
    ****************************************************************

    Example:  configure --prefix=/usr/local/isip
    Example:  ./configure --prefix=/usr/local/isip

    NOTE: Some administrators keep both the SunOS make and the GNU
    make on their systems at the same time.  On systems we have seen, GNU
    make was called "gmake," and Sun make was called "make."  To enable
    you to get the correct one, the configure process ends with a comment
    indicating the name of the GNU make command which you should type to
    start the make process.

2.  Run make with the depend option.  The configure process will tell
    you which command to type to get GNU make.  (Some systems include
    other makes, but our makefiles use features only available in GNU
    make, so it must be used.)  This step insures all header files are
    in the proper include/ directory.

    Example:  make depend

3.  Run make with the install option.  This time, make will compile
    all the programs, link the object modules together and move them
    to your install directory.

    Example:  make install

4.  Run make test.  All ISIP classes (and some utilities) come with
    internal diagnostics. If everything compiles properly, they will 
    run and produce a known set of output with the provided
    input data.  If problems occurred somewhere in the installation,
    the test should fail.

    Example:  make test

5.  A shell file ISIP_BASE_ENV.sh is created by the installation process and 
    will be placed in your defined installation directory. It contains
    the definition of the environment variables used by the ISIP programs.
    You should always enter "source ISIP_BASE_ENV.sh" when you want to run the
    ISIP programs.

    Example:  source ./ISIP_BASE_ENV.sh

Other Options:
--------------

There are other options available to the make program.

1.  Using the make target "clean" will remove the object files and executables
    created in the source directories. it will not affect the installation
    directories.

    Example:  make clean

2.  Using the target "distclean" will remove all the files that make
    clean does, and all the files which were installed by running
    'make install', including the library, binary, include, and
    documentation directories.  It will also erase the temporary files
    that configure created, which will allow you to have a clean
    re-installation by running configure again.  Note that, if the
    base install directory was created during the install process, it
    will not be removed.
    
    Example:  make distclean


Contact Points:
---------------

This package is distributed by the Institute for Signal and Information
Processing (http://www.ece.msstate.edu/research/isip/) at Mississippi State University
(http://www.msstate.edu/). We have a free help facility available via email
by mailing isip_help@ece.msstate.edu. This service can be used for assistance
in installing and running the system, requests for features, bug reports,
and other comments, complaints, suggestions, etc. Typically, we are able
to reply to your mail within a single business day.

For more extensive documentation on this project and the software
distribution, please visit the web pages:

 http://www.ece.msstate.edu/research/isip/projects/speech/
 http://www.ece.msstate.edu/research/isip/projects/speech/software/tutorials/

License:
--------

Institute for Signal and Information Processing
Mississippi State University

LICENSE AGREEMENT

This software is distributed without any restrictions.
You may copy, distribute, or modify this software as you see fit.

This package is provided "as is" and without any express or
implied warranties, including, without limitation, the implied
warranties of merchantability and fitness for a particular purpose.

#
# end
