GRAMMATICA README
=================

1. Introduction
---------------

  This package contains a parser generator and a run-time library for
  generated parsers. The parser generator reads a grammar file and 
  can create source code for a parser according to that grammar. 
  Currently only Java source code can be generated, but this is 
  likely to change in the near future.
  
  The run-time library contains the actual parsers. Currently, only a
  Java run-time library exits and it only supports LL(k) grammars. In
  future versions, it it anticipated that LALR(1) grammars will also
  be supported, as well as a more flexible version of LL(k) with 
  "source code" productions.
  
  The parser generator and the run-time library has some known 
  problems and shortcomings, and should be considered work in 
  progress. All known issues are documented separately in the 
  TODO.txt file in the doc directory. Please read that file before 
  filing bug reports.

  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
  separate LICENCE.txt file for more details.
  
  Please see http://www.nongnu.org/grammatica/ for more information.


2. Installation & Usage
-----------------------

  See the separate doc/INSTALL.txt file for installation and usage for
  instructions.
  

3. Acknowledgements
-------------------

  See the separate doc/AUTHORS.txt file for author and acknowledgement
  details.


4. Bug Reports
--------------

  See the following web page for further information about reporting
  errors:

    http://www.nongnu.org/grammatica/support.html


5. Contributing
---------------

  If you find this software package useful or interesting, please 
  consider contributing to the project. The easiest way to contribute 
  is to report errors or problems encountered when using this 
  software. Please see the project web site for more information:

    http://www.nongnu.org/grammatica/   
  
_____________________________________________________________________

Copyright (c) 2003 Per Cederberg. Permission is granted to copy this 
document verbatim in any medium, provided that this copyright notice 
is left intact.
