-------------------------------------------------------------------------------
File:                           README
Package:                        FSM Analyzer 2.0
Authors:                        Dr. Ratnesh Kumar and Greg Stamp
                                V2.0 10/2006.
-------------------------------------------------------------------------------
 
 		     * Dr. Ratnesh Kumar and Greg Stamp
 		     * Department of Electrical and Computer Engineering
 		     * Iowa State University
 		     * October, 2006.
 		     *
 		     * Copyright (c) 2006
 		     * All rights reserved.

===============================================================================
Special Thanks and Acknowledgements for development of the functions and the 
software to:

Bharath Oruganti
Electrical Engineering Department
University of Kentucky

Dr. Vijay Garg & Himanshu Sanghavi  
ECE Dept			    
University of Texas, Austin.

Dr. Susan Rodger, Magda & Octavian Procopiuc
Computer Science Dept
Duke University, Durham.
===============================================================================
****NOTE: MANUAL.ps is under development****
*******************************************************************************
Users are strongly advised to carefully read this file AND take a print out of 
MANUAL.ps (in the manual directory) before they use the software.
*******************************************************************************

This README file contains all the information required for users/developers of
the software to find and process the requisite information.

The directory structure of the software is as follows:

[bin]
[data]
[examples]
[manual]-----|
             [apps]
[src]--------|
             [c]--------|
                        [algorithms]
             [java]-----|
                        [flap]
                        [mainAnalyzer]
         

[bin]
Contains the command line driven program "decada" and the GUI fronted "analyzer.jar".  Contains file "AppSettings" which contains the default user mode (Beginner or Advanced). Contains file "MenuItems" which is used to generate the Applications menu in analyzer along with default filenames for the functions and the command to be passed to decada.

[data]      
Contains all the default data files used by "decada".  Results of the decada operations are saved here by default.

[examples]  
Contains some example files for new users of  FSM Designer.  These can be used for some basic understanding of how FSM's are created using FSM Designer.

[src]
Containes c and java source directories along with "cleanup" script used to remove files generated during source code compilation.
 
[c]
Contains main decada source code "decada.c" along with header files that provide a method for calling common functions.
    
[algorithms] 
Contains algorithm C source code for decada.
      
[java]
Contains flap and mainAnalyzer directories along with "runmejava" script for compiling analyzer
	
[flap]
contains JAVA source files initially from FLAP project.
     
[mainAnalyzer]
Contains the JAVA source files of FSM Designer.
     
[manual] 
Contains (a) The postscript file for the User's Manual of
FSM Analyzer.  Users are adviced to print MANUAL.ps (lp MANUAL.ps on Unix) and
read the entire manual carefully before using it for their applications, and
(b)  The text files that the software looks for, when the Information Window
(GUI) for all the different applications of the software is called.

[apps]
Contains help text files for individual applications used by the GUI.

===============================================================================
COMPILATION AND EXECUTION
===============================================================================

Compile the project by executing command "./runme"
Execute GUI by running command "java -jar analyzer.jar" in the bin directory
If desired, decada may be executed from commandline by running command "./decada"
 