Improved documentation for the ciabot scripts.
[git/mjg.git] / contrib / ciabot / README
blob6d8b549f580e638952e52d72423b5531ca1a80a6
1 These are hook scripts for the CIA notification service at <http://cia.vc/>
3 They are maintained by Eric S. Raymond <esr@thyrsus.com>.  There is an
4 upstream resource page for them at <http://www.catb.org/esr/ciabot/>,
5 but they are unlikely to change rapidly.
7 You probably want the Python version; it's faster, more capable, and
8 better documented.  The shell version is maintained only as a fallback
9 for use on hosting sites that don't permit Python hook scripts.
11 To test these scripts, your project needs to have been registered with
12 the CIA site.  Here are the steps:
14 1. Open an IRC window on irc://freenode/commits or your registered
15    project IRC channel.
17 2. Run ciabot.py and/or ciabot.sh from any directory under git
18    control, using the -p option to pass in your project name.
20 You should see a notification on the channel for your most recent commit.
22 See the file INSTALL for installation instructions.