ReadMe.txt - An intro document for Generator. 052901: Benjamin Han Created. 061501: Benjamin Han Updated the file list; added a section explaining how to run the code. ---------------------------------------------------------------------- 1. What is Generator ---------------------------------------------------------------------- Generator (gen) is a simple recursive-descent generator using a unification-based grammar formalism. It provides API for generating sentences from a unification-based grammar. It can be integrated with a frontend to provide a streamlined natural language generator. ---------------------------------------------------------------------- 2. File list ---------------------------------------------------------------------- lesser.txt: GNU Lesser General Public License. ReadMe.txt: This file. ChangeLog.txt: The change log. Makefile: Make file for all binaries. gen.hpp: gen.cpp: Code for Generator. genTst.cpp: Program for testing and demonstrating the use of Generator. Look here for solid examples. genTst.out: The output from genTst. ---------------------------------------------------------------------- 3. How to build the code ---------------------------------------------------------------------- You need to get Toolbox library and UKernel package to build this code (visit http://www.cs.cmu.edu/~benhdj/c_n_s.html). Download all and make the directory structure like this: -+- Toolbox | +- UKernel | +- gen Take a look at Makefile of Generator and modify parameter settings as you wish, then a). For building obj files only: type "make" b). For building the testing program: type "make test" Nothing unusual right? ---------------------------------------------------------------------- 4. How to run the code ---------------------------------------------------------------------- Pay attention to genTst, as it summarizes all you need to know to run Generator inside your code. For your convenience genTst.out shows you the output from the program. ---------------------------------------------------------------------- 5. Copyright, disclaimer, comments, etc. ---------------------------------------------------------------------- a. Any bug reports and comments are extremely welcome. Please send comments to Benjamin Han . b. This code is distributed under GNU Lesser General Public License - you can read a copy enclosed in this package (lesser.txt). You're free to use the code provided you give the accurate reference and include the source code. There is however absolutely no guarantee from the author in any form and/or for any purposes. Use it at your own risk.