=========
 READ ME
=========

  (C) in 2007 by OpenDocumentPHP Team (team@opendocumentphp.org)
	  published under the GNU General Public License 2.0

--------------
 Introduction
--------------

As a customer, user, normal developer you should use the production code base 
and upgrade your PHP to at least 5.2.0. This project will not support any 
earlier PHP releases. You should also include the PEAR, ZLIB and ZIP modules.

You can download the latest OpenDocumentPHP release as 

					"OpenDocumentPHP-X.Y.Z.zip" 
				
from our sourceforge.net download area or you can build it yourself out of the 
source files found in the subversion repository.

We recommend you to download the "OpenDocumentPHP-X.Y.Z.zip" file if you are 
not an OpenDocumentPHP developer. 
But if you still want to use the 

					"OpenDocumentPHP-X.Y.Z-src.zip" 
					
files as a starting point or the current developer source right out of the 
subversion repository, please read on at the "For OpenDocumentPHP developers" 
section of this README file.

Please include 'OpenDocumentPHP/" to your classpath. Now you can include the 
main classes like this:

<?php
//...
$root_path = './';
require_once $root_path . 'OpenDocumentPHP/OpenDocumentText.php';
//...
$text_document = new OpenDocumentText('SimpleText.odt');
// insert some more stuff here ;-)
// Write OpenDocumentPHP document names 'SimpleText.odt' to disc.
$text_document->close();
?>


--- --- --- 

--------------------------------
 For OpenDocumentPHP developers
--------------------------------

If you want to be a OpenDocumentPHP developer you should also use at least 

							PHP 5.2.0 
						
and should be familiar with object-orientated development. Also you should know 
how to use PEAR and install at least the following PEAR packages:
______
Phing: 
""""""
												(Phing 2.3.0beta1 or newer)
You can find news about Phing on there project homepage at http://phing.info.
You can easy install the latest release by running these commands from the 
command line:

> pear channel-discover pear.phing.info
> pear install phing/phing

As long as the new Phing 2.3.0 is not released, please use Phing 2.3.0beta1 or 
better.
______________
PhpDocumentor: 
""""""""""""""
												(PhpDocumentor 1.3.1 or newer)

You can find news about PhpDocumentor on there project homepage at 
http://www.phpdoc.org. You can install the latest release by something 
like this: 

> pear install PhpDocumentor

________
PHPUnit: 
""""""""
													(PHPUnit-3.0.4 or newer)
													
You will find more about PhpUnit on the project homepage at http://phpunit.de.
You can install the latest package on your system by do something like this:

> pear channel-discover pear.phpunit.de
> pear install phpunit/PHPUnit


-------------------------------------------------------------------------------
$Id: README 157 2007-03-15 11:39:52Z nmarkgraf $
-------------------------------------------------------------------------------
