Copyright (C) Michael Avery <leachman_ss@yahoo.com>

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.




Requirements:
=============
- PHP >= 4.3
- A web server which supports PHP and MySQL
- Task Automation tools such as cron
- A MySQL database to store information in, and appropriate access

** Note **
This software has been developed and tested using Apache  / Linux ONLY
Although it should work on other platforms, they have not bee tested.
If you manage to get this working on another platform, please contact me
with bugs, patches, etc
** Note **


INSTALLATION:
=============

There are a few steps required to configure this pakcage for use on your site.
Follow these instructions as closely as possible.  Advanced users can of
course ignore me :)

1) Database Preparation
-----------------------
** Note **
Database creation and administration is beyond the scope of this project.
This tool is designed for webmasters and league administrators who are
familiar with the topic of MySQL administration.  Anything you do to
your database is solely your responsibility.  Creating a working backup
of your database before installing this package is suggested.
** Note **

If you have an existing database that you want to store data in, you will need
your credentials handy.

a) Review lfs-createObjects.sql and create database tables
	This file should be used to create and initializethe the database
	with the appropriate data.  If you don't know how to do this,
	see the *** Note *** above!

b) Edit dbconfig.php
	This file is used to specify database specifics for use by poll.php


2) Configure poll-lfs.php
---------------------

Review the documentation in poll-lfs.php and configure the required variables.
poll-lfs.php is the script that speaks to the LFS server and populates the database
with the appropriate information


3) Automate the execution of poll-lfs.php
-------------------------------------

I Strongly recommend that you use a process automation tool such as
cron or Windows Task Scheduler to automate the execution of the poll-lfs.php
script.  If you integrate the execution of the poll script with
the rendering of web pages on your site, a downed server can
introduce page load delays equivalent to 1 second for each retry! (see poll-lfs.php)

As an example, to run poll-lfs.php every minute on a UNIX-like system:

* * * * * php /path/to/poll-lfs.php



4) Configure mod_lfs_monitor.php
--------------------------------

mod_lfs_monitor is a sample display php block.  You may well want to
change how the information is displayed in your site.  As this file is
an example, you are encouraged to modify and extend it.  This sample
module is the one currently active at http://www.nasrl.net

Be sure to read the comments in this file closely, as they offer several
tips and hints to help you along.



============================================================================

Other notes
-----------

mod_lfs_monitor.tpl is a Smarty template file for use with the bitweaver CMS.
For more information on the excellent bitweaver CMS, check http://www.bitweaver.org

Please contact leachman_ss@yahoo.com with bugs, patches, etc.
