================
Ruby/IRC Library
================

This is a Ruby library for IRC (Internet Relay Chat) and
consists of low-level communication library and client
framework.

There are few documents. See the source and samples.
Please have good manners on use.

* Requirement

    Ruby 1.6.x  (You can get it from http://www.ruby-lang.org/)

* Files in the distribution

(top directory)
    README                 this document
    COPYING                GNU Public License
    LICENSE		   Ruby's License
    BUGS		   about bugs
    TODO		   to do list
    MEMO.ja		   memo for development (Japanese)
    bot.rb                 example of `bot'
    bot.ja.rb              example of `bot' (Japanese)
    localize.rb            localization library for Japanese
doc.ja/                Documents in Japanese
    index.html             index page
    irc-lib.doc            low-level communication (ruby-irc-lib)
    irc-lib-api.doc        low-level communication API Manual
    irc-client.doc         client frame-work (ruby-irc-client)
    irc-client-api.doc     client frame-work API Manual
irc/                   Library
    const.rb               constants definitions
    irc.rb                 low-level comm. (Connection,Message,LogMessage,...)
    agent.rb               agent templates (Active/PassiveAgent)
    client.rb              clients (Client)
cpi/, cpi.ja/          Client plug-ins
    init.cpi               for start-up
    syslog.cpi             system logger for debugging
    operator.cpi           for bot operation
    omikuji.cpi            `omikuji' - a written oracle
    dice.cpi               automatic dice for TRPG
    userlog.cpi            an example of user logging
log/                   logging directory
    syslog                 system log (for debugging)
    userlog                user log

* References

RFC 1459 Internet Relay Chat Protocol (updated by RFC 2810-2813)
RFC 2810 Internet Relay Chat: Architecture
RFC 2811 Internet Relay Chat: Channel Management
RFC 2812 Internet Relay Chat: Client Protocol
RFC 2813 Internet Relay Chat: Server Protocol

* Copying

You can redistribute Ruby/IRC and/or modify it under the
same term of Ruby (see LICENSE file).

* Author

Feel free to send comments or bug reports to:

    Hiroshi IGARASHI <iga@ruby-lang.org>



$Author: knu $
$Date: 2001/01/31 06:15:59 $
$Revision: 1.4 $
Local Variables:
eval: (rename-buffer "README for ruby-irc")
End:
