# vim: set ft=text80:
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
#
#              C E D A R
#          S O L U T I O N S       "Software done right."
#           S O F T W A R E
#
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
#
# Author   : Kenneth J. Pronovici <pronovic@ieee.org>
# Language : N/A
# Project  : Christmas 
# Package  : Fun scripts and programs
# Revision : $Id: INSTALL,v 1.3 2003/09/08 20:31:50 pronovic Exp $
# Purpose  : Installation instructions
#
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #

# This file was created with a width of 80 characters, and NO tabs.

#
# Installing package dependencies
## 

The Secret Santa script relies on a number of outside packages.  Before
installing Secret Santa, you must make sure that certain dependencies
are met.

First, Secret Santa is written in and depends on Python
(http://www.python.org), version 2.2 or greater.  Most Linux
distributions already have Python pre-packaged.  Cedar Backup also
depends on the Python 4Suite XML package, so it must be installed before
you install Secret Santa itself.  

Finally, in order to run the secret-santa script, you must have some
sort of MTA (mail transfer agent), such as Exim, Postfix or Sendmail,
installed.  I really have no idea what to do for this requirement
under Windoze.  If you get it working, please let me know how you did
it, so I can ammend this documentation.


#
# Installing the package
##

Secret Santa is distributed as a standard Python distutils source
distribution.  When you un-tar the Secret Santa tarfile, you will find
a directory containing (among other things) a file called setup.py.
Simply use the command:

   python setup.py install

to install Secret Santa.  Note: in the command, 'python' must be
the Python version 2.2 interpreter.  If you are running on a UNIX
system, you may need to be root to run this command.

