source: svnbot/trunk/README @ 6

Last change on this file since 6 was 6, checked in by simon, 19 years ago

Added whippingboy note to README. Remove the option of a later version of the GPL from the license blurb. Minor re-formatting.

File size: 1.8 KB
RevLine 
[6]1svnbot -- A commit notification bot:
[1]2
3As nice as the CIA Open Source Notification System[1] is, I wanted
4something a little more simple.  I was not overly interested in
5statistics, and Trac[2] provides most of what I need in a web-based
6interface to Subversion[3], I just wanted a simple IRC bot that would
7alert people when something is committed to a repository.
8
[6]9Since I have been present in the #trac IRC channel on Freenode, I have
10noticed whippingboy[4].  I am told this is just a Supybot[5] with an RSS
11plugin, which polls Trac's timeline RSS feed from a cron job.
[1]12
[6]13
[1]14REQUIREMENTS
15
16svnbot is written in Python, and uses the Twisted API:
17
18  * Python (>=2.2), from http://python.org/
19  * Twisted 1.3, from http://twistedmatrix.com/ (untested in Twisted 2)
20
21
22USAGE
23
24Twisted provides packaging facilities to supposedly make things easy on
25running and configuring Twisted applications, but I haven't done that
26yet. :)
27
[6]28Instead, edit svnbot.py to change the IRC server and channel, and run
29with:
[1]30
31    twistd -oy svnbot.py
32
33
34TODO
35
36  * Stuff
37
38
39LICENSE
40
[6]41Svnbot is free software; you can redistribute it and/or modify it under
42the terms of the GNU General Public License as published by the Free
43Software Foundation; either version 2 of the License.
[1]44
[6]45Svnbot is distributed in the hope that it will be useful, but WITHOUT
46ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
47FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
48for more details.
[1]49
[6]50You should have received a copy of the GNU General Public License along
51with Svnbot; if not, write to the Free Software Foundation, Inc., 51
52Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
[1]53
54----
551. http://cia.navi.cx/
562. http://www.edgewall.com/trac/
573. http://subversion.tigris.org/
[6]584. http://whippingboy.homeunix.org/
Note: See TracBrowser for help on using the repository browser.