CoMET is a stand-alone member equity tracking application designed to 
integrate with IS4C and Fannie.
Copyright (C) 2009  Matthaus Litteken

This file is part of CoMET.

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 3 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, see <http://www.gnu.org/licenses/>.

*********************************************************************
****************************	README	  ***************************
*********************************************************************

CoMET is written in PHP, with a lot of support from jQuery. It uses MySQL 
for the database backend, any database that supports views would work with 
some modification. It requires PHP of at least version 5.3 and has been 
tested and designed with MySQL 5. It uses PEAR for Auth, Mail, and Mail_Queue
support.

A. General Information
B. Requirements
C. Installation
D. Configuration/Setup
E. Usage
F. Troubleshooting
G. Extending

*********************************************************************
********************	General Information		*********************
*********************************************************************



*********************************************************************
************************	Requirements	*************************
*********************************************************************
- PHP 5.3 or later with mysqli, curl and cli extensions enabled
- MySQL 5 or later
- PEAR packages: Net_SMTP, Mail, Auth, MDB2, MDB2/mysqli, Mail_Queue
- Access to cron


*********************************************************************
************************	Installation	*************************
*********************************************************************
Untar the comet.tar.gz into a directory within the webroot. Create the
appropriate virtualhost file. Open a web browser to the installed location
and install.php.


*********************************************************************
***********************	Configuration/Setup  ************************
*********************************************************************
The installation script will prompt you for a username, password, and 
email address.


*********************************************************************
****************************	Usage	*****************************
*********************************************************************



*********************************************************************
*************************  Troubleshooting	*************************
*********************************************************************



*********************************************************************
**************************	 Extending   ****************************
*********************************************************************