========================================
                   Uger
 
 Author: Peter K Chan (peter@oaktop.com)
 License: GPL 2.0
 Release: 0.3
 ========================================

This is Uger, an user group web application for tracking events, membership, and
payments.

========== Installation ==========
Uger is a regular Rails application and can be installed just like any other
Rails application.

1) Unpack - unpack the Uger directory to a path of your choice.

2) Template - there are some template files that you need to put into effect.
       You can do so as follow:

(assuming that you are in the Uger directory)
cd config
cp database.yml.template database.yml
cp environment.rb.template environment.rb
cp uger.yaml.template uger.yaml

   If you notice any other .temlate files, you can do the same to put them into
effect (i.e. dropping the .template prefix)

3) Database - edit config/database.yml to configure how Uger/Rails will access
   	    your database, then run the following to set up the database:

rake migration

4) Set up - first, launch Uger by

ruby script/server

     then go to http://localhost:3000/ and you should see Uger running. The
     first thing you should do is to sign up as a user. Uger is configured to
     automatically promote the first user to be the administrator. Once you
     have your own administrative account, you can easily add other
     administrators by having them sign up, then go to the list of users
     to promote them.

From this point on, Uger is running successfully. You can follow any of the
many Rails deployment guide to run Uger under a variety of environments, such
as Mongrel, Apache, Lighttpd, etc. You will probably also want to switch to
the production environment.

========== Deployment Reminder =========
If you use Apache, you will probably want to customize public/.htaccess
to specify how Apache run Rails (e.g. FCGI).

========== Customization ==========
To customize Uger for your site, you should look at the following files:

config/uger.yaml
 - this file contains most of the texts used on the site. As a hint,
 if your user group is not in the U.S., you may want to blank out the
 automapper option, as the service does not currently (Oct, 2006) support
 non-US addresses.

 You will probably also want to set the timezone setting. Uger stores all
 event dates internally as UTC, but will convert to the configured timezone
 before displaying the time. Uger uses the TZInfo library
 (http://tzinfo.rubyforge.org/), so you can configure your own timezone by
 using the same name as supported by this library.

public/stylesheets/default.css
 - this CSS file contains styles used inside Uger.
 
app/views/layouts/uger.rhtml
 - If you need to customize Uger beyond UI texts or styles, you can edit
   this file.