MAD: Software for the Modular Action Description Language
Copyright (C) 2008, 2009  Selim T. Erdogan

Contents of this README file:
-----------------------------
- Requirements for building the code
- Building the source code
- Running the program
- Getting more information
- Contacting us
- License info


Requirements for building the code:
-----------------------------------
You will need GCC, GNU Bison, and Flex to build this code.  
(It might be possible to modify the Makefile to use other tools, but we 
haven't tested this.)

We have successfully tested MAD in the following environments:
- Debian GNU/Linux (sid), gcc 4.3.3, flex 2.5.35, bison 2.4.1
- SunOS 5.9, gcc 4.2.2, flex 2.5.33, bison 2.0


Building the source code:
-------------------------
While in the src/ directory, simply type the command

  make


Running the program:
--------------------
The executable will be named "mparse".  It may be run as

  mparse [-i] <input-file-1> ... <input-file-n>  [-o output-file]

where the parts within square brackets are optional.  The -i option
will ask the user what kind of output to generate.  Unless an output
file is explicitly specified, all output will be written to the file
"mparse.output"


Getting more information:
-------------------------
The file mad-manual.pdf is the user's manual for MAD.

The examples/ directory contains a simple library of action descriptions
and domain formalizations using that library.

The MAD homepage at

  http://www.cs.utexas.edu/~tag/mad/

contains many resources about MAD.


Contacting us:
--------------
Please send any comments, questions, bug reports, etc. to

  Selim T. Erdogan  <selim@cs.utexas.edu>


License info:
-------------
MAD 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 3 of the License, or
(at your option) any later version.

MAD 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.

The src/ directory should contain file named COPYING --- a copy of the 
GNU General Public License.  If not, see <http://www.gnu.org/licenses/>.
