=================
INSTALLING PUNJAB
=================

This document contains instructions on installing punjab
on your system. 

-------------
Obtaining Punjab
-------------

Punjab can be located at the punjab web site, 

   http://www.butterfat.net/wiki/Projects/PunJab


-------------
Dependencies
-------------

Please make sure all dependencies are met before submitting a troubleshooting question.

- Python 2.3>

- Twisted >= 2.4

  - Twisted-words >= 0.5.0
  - Twisted-web  >= 0.5.0

  Recommended
    - Twisted-conch >= 0.5.0

  NOTE : 
    You can download all of these packages with the Twisted Sumo package. 
    http://twistedmatrix.com/

- A jabber server like jabberd 1.4.x


-------------
Installing Punjab
-------------

1. Untar the current punjab-X.X.tar.gz file in a directory you would 
   like punjab to reside. 

shell>tar vxzf punjab-X.X.tar.gz

2. Run setup to install

shell>python ./setup.py install

3. Configure punjab 

shell>mktap punjab --port=5280 --host=localhost --xmlrpc=1 --httpp=1 --httpb=1 --soap=1 --html_dir="./html"

For viewing all options, run:

shell>mktap punjab --help

4. Run punjab 

shell>twistd -f punjab.tap

5. HAVE FUN!!


---------------------------
Extending Punjab
---------------------------

You are able to extend punjab in many ways. 

-------------
Support
-------------

 http://www.butterfat.net/wiki/Projects/PunJab