README

================================================================================
                      Piazza Question Answering System
              Designed for EECS 280 at the University of Michigan
================================================================================
Developed from the open source OpenEphyra Question Answering System,
PiazzaQA is designed for computer science courses that make use of Piazza
as an open class forum. 

PiazzaQA is designed to respond appropriately to student questions by using
course documents and previous piazza posts as reference material. This QA system
is capable of referencing most related pizza questions and class documents while
also citing the most related answer from said sources. 
================================================================================

Acknowledgements:
-----------------

OpenEphyra was originally developed by Nico Schlaefer, but many others have made
valuable contributions. Special thanks go to:

- Guido Sautter, for his work on definitional QA and the NE recognizer.
- Justin Betteridge, who developed the answer type classifier.

Content of this Distribution:
-----------------------------

bin/           Java class files
cache/         Cache files
conf/          Configuration files
doc/           Javadoc documentation
index/		   Indri indexed files
lib/           Third party libraries
log/           Log files
res/           Resource files
scripts/       Command line scripts
src/           Java source files
build.xml      Ant build file for OpenEphyra
javadoc.xml    Ant build file for the Javadoc documentation
CHANGES        Changes made in new revisions
LICENSE        GNU General Public License
README         This file

Getting Started:
----------------
Currently there is no easily executable file to run. This file is capable of being edited
and tested in Eclipse IDE.

The only system requirements are a Java runtime environment (version 1.5 or
later) and about 1 GB of free RAM.