TCB::AddressBook - an interface for the TCB Group's Address Book
================================================================

TCB::AddressBook is a basic database-backed address book, in this case
written for the Theoretical Biophysics Group at the University of
Illinois.  It is written for DBIx::Frame - more information can be found
on that page.

Specific tables are described in the following modules:

  TCB::AddressBook::SBook	Actual address information

Prerequisites
=============

You must have the following modules installed:

  DBIx::Frame           v1.05

You will also need a running database (mysql is the only one tested), and 
permission to either use the existing contents or create new ones.

Installation Notes
==================

Installing this software is easy:

  perl Makefile.pl
  make
  make test
  make install

Creating the database is a bit trickier - you'll need a running mysql
database, and permission to create the tables necessary.  Once you've got
that, log into the database server and run:

  system_create.pl -b DATABASE -u USER -p PASSWORD -ca 

You'll probably want to look at the script first, and read the
installation instructions for new databases from the DBIx::Frame
installation manual.  

Further installation instructions are in 'INSTALL'.

Documentation
=============

All of the documentation is in the manual pages - 'man TCB::AddressBook'
after installation, or 'pod2text TCB/AddressBook.pm | less' right now.
'perldoc TCB::AddressBook' probably also works.

Web Page
========

http://www.ks.uiuc.edu/Development/MDTools/tcb-addressbook

                            - Tim Skirvin (tskirvin@ks.uiuc.edu)
-- 
   Theoretical and Computational    http://www.ks.uiuc.edu/~tskirvin/
Biophysics, Beckman Institute, UIUC    Senior Systems Administrator
