************************************************************************************************
** Project:     FSMGenerator
** Module:	
** File:	README
** Date:        2002.08.01
** Author:      Pavel Bekkerman (chpavel@tx.technion.ac.il)
** Copyright:   Copyright (C) 2002, 2003 Pavel Bekkerman
** License:
**		This program is free software; you can redistribute it and/or
**              modify it under the terms of the GNU General Public License as
**              published by the Free Software Foundation; either version 2 of
**              the License, or (at your option) any later version.
**
**              This program is distributed in the hope that it will be useful,
**              but WITHOUT ANY WARRANTY; without even the implied warranty of
**              MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**              GNU General Public License for more details.
**
**              You should have received a copy of the GNU General Public License
**              along with this program; if not, write to the Free Software
**              Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
**
** Contact:     Pavel Bekkerman (chpavel@tx.technion.ac.il)
************************************************************************************************

This is a README file supplied with the distribution of the FSMGenerator package.
Please, read carefully the information below.

Installation

To install FSMGenerator, first build it using 'make all'. If the build process encounters problems, try to fix them. The common problem would be that gcc does not find appropriate libraries to link with. The prerequisity is STL, found in 'libstdc++.so', which must be on your LIBPATH, usually in /usr/lib.

After the build is done run 'make install'.

Generating FSM

To use the FSMGenerator, one should write a configuration file for the FSM. See 'test.fsm' for example.
Then run 'fsmgenerator' command on this configuration file as follows:

fsmgenerator test.fsm Java .

This will generate Java source code files for the FSM configured in 'test.fsm' and store them in the separate directory with the name of the FSM, created under current directory '.' .

Interfacing Generated FSM

Once FSM is generated, it can be interfaced from the user's software. For details, see: 'FSMGenerator User's Guide'.
