Contents:
=========

This is the AGFL system. The directories contain the following items:
 - doc: the user documentation
 - liblexicon: the directories with:
     * src: the lexicon library reading routines
     * doc: the system documentation for the lexicon library
 - lexgen: the lexicon generator, with:
     * src: the C++ sources of the lexicon generator
     * doc: the system documentation of the lexicon generator
 - gen: which contains the parser generator, with:
     * src: the sources of the parser generator and the runtime system
     * doc: various documents, mostly system documentation
     * test: various test grammars
 - test: a directory with various test grammars with lexicon.


Installation:
=============

AGFL has been written in C and CDL3. You'll need a working GCC and
CDL3 compiler to compile it yourself. You can download CDL3 from
the CDL3 website at http://www.cs.kun.nl/cdl3

The included autogen.sh script will run these utilities first:

	libtoolize
	aclocal
	autoheader
	automake
	autoconf
	configure
	
autogen.sh passes its parameters to configure, so you'll probably
end up running something like

	./autogen.sh --prefix=/usr/local/kun --with-cdl3=/usr/local/kun
	make
	make install

If you run on BSD, remember to use gmake, not make.

General installation instructions regarding the configure; make; make
install cycle are in the INSTALL file.


Usage:
======

After installing the AGFL system, grammars and lexica can be compiled.
Suppose there is a grammar in the file "grammar.gra":

    /path/to/agfl/bin/gen grammar.gra

This will generate an executable named "grammar". When you start the
executable, the program will give you a prompt:

    >>

Here you can type the input to the parser. After pressing <enter>, the
parser will start to recognize the input according to the grammar. The
parser can give more (verbose) output putting options on the
command-line. The -h option will give an overview of the possible
options. This also works for the parser generator "gen".


Licenses:
=========

The components of the AGFL system are licensed as follows:
 - the programs (which reside in the "${prefix}/bin" directory) are
   subject to the GNU GENERAL PUBLIC LICENSE, which can be found in the
   source package in the file named COPYING. If not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
   MA 02111-1307  USA
 - the libraries (residing in the "${prefix}/lib" directory) and the
   include files (residing in the "${prefix}/include" directory) are
   distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE. You should
   have received a copy of the GNU Library General Public License along
   with this library; if not, write to the Free Software Foundation,
   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA

In addition, each source file has the appropriate license mentioned at
the start.

-- The AGFL team <agfl@cs.kun.nl>.

($Id: README,v 1.7 2002/06/09 22:50:52 pspiertz Exp $)
