$Id: README.txt,v 1.9 2004/06/08 06:47:58 josheli Exp $

obligatory README file

-------
INSTALL:
    
  1. Un-tarring/zipping the statrat.tar.gz file should create a directory like:
      /statrat
      /statrat/rutherglen

     You *should* be able to change the names of these directories, and statrat
     will still work. Your milage may vary though.

  2. In the /rutherglen directory there is a file called statrat.sql
     with the database table definitions. If you don't have a preexisting
     database, you'll need to create a database manually.

  3. Loading the statrat.sql file in MySql creates a default user: admin
     with a default password: changeme
     You can find the "insert" sql statement at the bottom of statrat.sql
     if you wish to change these values.
     **** YOU ARE ENCOURAGED TO CHANGE THESE VALUES.!!! ****

  4. Once you've (created and) loaded the database, go to the 
     file /rutherglen/sr_common.php and set the "DATABASE INFO"
     in that file to match your setup.

     EXAMPLE VALUES:

     DEFINE('STATRAT_DB_HOST','localhost');
     DEFINE('STATRAT_DB_USER','my_login_name');
     DEFINE('STATRAT_DB_PASSWORD','my_database_password');
     DEFINE('STATRAT_DB_DATABASE','statrat');

  5. Ok, now you're ready to build some teams. Go to
     http://www.example.com/statrat/sr_index.php
     and login with the username and password from step 3 above.
     From here you can create a team, then create some players
     for that team.

  6. The team will, presumably, play games. Every game, in turn, must
     be part of a "Season", so I've taken the liberty of creating a 
     "Default Season" for you. This season has been given a starting
     date of today, and an ending date 6 months from today. Really,
     these dates, and the season itself, are arbitrary, and you may 
     of course edit or delete this, but you'll need to have at least 
     one "Season" for statrat to function (what it considers) properly. 
     In theory, this Season will correspond to an actual season. 
     There should be a screen to create/edit Seasons. 
  
  7. Once you've created a team with some players, and have a season to play in,
     you need to set up a "schedule". There is a rudimentary schedule manager
     for this, or you may work directly in the database in the stat_schedule table. 
     If you do it manually (or through a batch) the following fields 
     in 'stat_schedule' ARE NOT used, so don't worry about them now:

      `home_team_id`
      `home_team_score`
      `visit_team_id`
      `visit_team_score`

      (You'll also leave the team_score, opponent_score empty (or '0') too of course).

   7. You should now be ready to enter stats. Maybe the process/interface
      is intuitive ... maybe not. Good luck and thanks.


NOTES:
    Much of the code sucks, it's not very extensible, things are un-implemented. 
    It should be redone, and if I ever have time, I'll do it. But for now, we can 
    all live with it, and if you're nice and not demanding, I'll support and help 
    you with this "software" as much as possible.

    Sorry it's so incomplete. It started out as a simple one team "application", 
    but making it work for multiple teams/leagues/divisions and writing out the 
    install routine for the first time makes me see it really needs some work.


-------
LICENSE:
    THIS PACKAGE OF SCRIPTS IS FREE AND UNDER NO LICENSE.

    NO WARRANTY, SUPPORT, OR LIABILITY (OR ANYTHING ELSE),
    EXPRESSED OR IMPLIED, IS OFFERED, ASSUMED, GIVEN OR TAKEN.
    
    YOU ARE FREE TO REDISTRIBUTE THESE SCRIPTS, BUT I ASK THAT
    YOU KEEP MY NAME AND EMAIL ADDRESS ATTACHED.
    
    YOU ARE FREE TO ALTER THIS SCRIPT IN ANY WAY, BUT I ASSUME
    NO LIABILITY.
    
    YOU ARE FREE TO GIVE ME MONEY IF YOU WISH, BUT I ASSUME NO
    ADDED GUILT OR RESPONSIBILITY IF YOU DO, AND YOU SHOULD
    FEEL NONE IF YOU DON'T.