                                                                   -*- Text -*-

CVSToys is a collection of companion tools for the Concurrent Versions System,
better known as CVS.  The biggest best and only toy we've got is Fresh CVS,
a commit monitoring daemon which can keep a mirror of the repository or
checked-out working copy up to date, and send out notifications by e-mail, on
the web as HTML or RSS, or to a chat service such as IRC.

About this Release:
==================

This release 1.0.10 of CVSToys is the "If it ain't broke, don't fix it"
release.  And boy were some things broke, due to changing APIs in the
underlying Twisted framework.  On the other hand, if your current version
is working for you (i.e. you haven't upgraded your Twisted since it was at
version 1.0.7), you could skip this release.

See the NEWS file for more about what's changed.


Installation:
============

It's a distutils thing.  Run `setup.py`.

Getting Started:
===============

Setting up the sever:
--------------------

Run the script `freshcvs-setup`.  It will make the necessary changes
to your CVSROOT directory for the Fresh CVS daemon to be notified on
every commit.  It will also create a freshcvs.tap for you; run it with
`twistd -f freshcvs.tap`.

Note: twistd creates several files, including a pidfile and a log.  If
you don't want these written to the current directory, see the options
in the twistd(1) manual.

You'll probably want to modify the configuration to do something more
interesting than just write to twistd.log.  Check out the freshCfg file
from the CVSROOT module, see doc/config.txt for information about what
you can put in it, and check it in when you're done.

To have the service managed by init (i.e. start at boot time), Debian
users can use tap2deb(1).  RedHat users refer to the example init.d
script in doc/rh-init.d-freshcvs.

IRC:
---

Many of you are downloading this package to have commit notifications
delivered to you on IRC.  To do this, make sure you have a PBService
in your freshCfg, and then make seperate cvswords application; do
`mktap cvswords --help` for a list of all options.  The --cvs-user and
--cvs-pass options must match the user/pass pair for the PBService.
Start the new application with `twistd -f cvswords.tap`.


Requirements:
============

Twisted, v1.2.1alpha1 or later, http://twistedmatrix.com/

CVS, http://www.cvshome.org/

  The usage of 'cvs rdiff' in actions.mail seems to work with version
  1.11 of CVS, but not 1.10.


Links:
=====

CVSToys - 
http://purl.net/net/CVSToys

CVSToys mailing list <cvstoys-list@twistedmatrix.com> -
http://twistedmatrix.com/cgi-bin/mailman/listinfo/cvstoys-list

Competitors:
-----------

activitymail -
http://www.cpan.org/authors/id/D/DW/DWHEELER/activitymail/

syncmail -
http://sourceforge.net/projects/cvs-syncmail

cvsmail - 
http://sourceforge.net/projects/cvsmail

commit_prep and log_accum, 
http://ccvs.cvshome.org/source/browse/ccvs/contrib/

CVSTrac, "a web-based bug and patch-set tracking system for CVS" -
http://www.cvstrac.org/

commitmessage, handles SVN as well as CVS -
http://commitmessage.tigris.org/

CVS Monitor, a web view of recent patch sets and statistics -
http://ali.as/devel/cvsmonitor/

http://www.cvshome.org/cvslinks.html
http://www.cvshome.org/dev/addons.html

Contact:
=======

Kevin Turner <acapnotic@twistedmatrix.com>
also may be found as Acapnotic in #twisted of irc.freenode.net.

-- 
$Id: README,v 1.22 2004/03/05 09:02:49 acapnotic Exp $
