$Id: README.txt 55 2006-04-20 06:28:44Z user57 $

P4Spam 1.1

About
-----

P4Spam is a Perforce change review daemon which spits out sexy HTML-styled
notification emails.

For more information see:

    http://p4spam.sourceforge.net


Requirements
------------

 * Python 2.3
 * Perforce client (tested with 2005.1, might work with other clients)


Installing
----------

Installing is relativly simple, just unpack the release distribution, make some
changes to the configuration file, and then hook up to cron (or run as a
daemon).

Extract the distribution:

    cd /opt
    gunzip -c ~/p4spam-1.0.tgz | tar xf -

Edit the configuration:

    vi p4spam-1.0/bin/p4spam.conf

You may need to edit bin/p4spam (or bin/p4spam.bat on Windows) to set the path
of the Python executable if it is not in your path.

Add to your crontab:

    If you installed into /opt/p4spam-1.0, then you might have:

    <snip>
    # Process reviews
    * * * * *       /opt/p4spam-1.0/bin/p4spam.cron
    </snip>

 * * *

By default P4Spam uses the 'p4spam.lastchange' counter.  If using for an
existing Perforce server and you've got a bunch of existing changes, you might
want to set the counter before running to the next change to process, like:

    p4 counter p4spam.lastchange 2000

The next time P4Spam runs it will start with change 2001.

 * * *

See the provided p4spam.conf for full details on the configuration options.

You can always specify a specific configuration by using the --config flag.

See `bin/p4spam --help` for more details.

 * * *

Probably missed something... check the website (mentioned above), or the mailing
lists for more information.