eXcavator, an XML query processor that sit on top of XML_PullParser

Copyright (C) 2006  Myron Turner
Myron_Turner@cc.umanitoba.ca

This program 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 2
of the License, or (at your option) any later version.

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
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

----------------------------------------------------------------------------------
eXcvator README


1. Installation:  


     	    tar -xzf eXcvator.tgz
                OR
            tar -xzf eXcvator-n1.n2.n3.tgz
                where n1.n2.n3 is the version number



2.  This tarball contains all the packages necessary to run eXcavator,
    both the eXcavator and XML_PullParser distributions.

  To use eXcvator place the following statement at the top of your script:           

		require_once "install_directory/eXcvator.inc";    
   
  This will pull in all packages necessary to use eXcavator:
		eXcvator_QueryParser.inc 
                XML_PullParser.inc
		XML_PullParser_Errors.inc 

  
3. Documentation Directory:  manual
       
   manual/html
	This directory contains the manual in html format, and is accessible through
	manual/html/contents.html

  manual/xml			
        This directory contains the manual in xml format, together with the script which
        converts the xml to html on the fly, which is article2html.php.  These 
        files are accessible through xml/html/contents.html

  manual/doc
  	Class documentation produced by phpDocumentor
  manual/listings
	Contains all the example code from the Manual.	


4. Tests directory: tests
	This directory contains a set of PHPUnit tests.  There is a set of scripts named t1.php, t2.php, etc.
	These can be called individually.  In addition, there is a batch script named php_unit.php which will
	run all the individual t scripts.
	


	
web site:  http://www.mturner.org/XML_PullParser/
contact:   Myron_Turner@shaw.ca