README

   1 * What's this?
   2
   3 Riece is an IRC client for Emacs.
   4
   5 Riece provides the following features:
   6
   7 - Several IRC servers may be used at the same time.
   8 - Essential features can be built upon the extension framework (called
   9   "add-on") capable of dependency tracking.
  10 - Installation is easy.  Riece doesn't depend on other packages.
  11 - Setup is easy.  Automatically save/restore the configuration.
  12 - Riece uses separate windows to display users, channels, and
  13   dialogues.  The user can select the window layout.
  14 - Step-by-step instructions (in info format) are included.
  15 - Mostly compliant with RFC 2812.
  16
  17 * Directory tree
  18
  19 This package contains following directories:
  20
  21 lisp/ - Emacs Lisp files.
  22 doc/  - Documentation files.
  23
  24 * Requirements
  25
  26 - Emacs 20.7 or later / XEmacs 21.4 or later
  27 - Ruby 1.8 or later (optional)
  28
  29 * Installation
  30
  31 $ ./configure
  32 $ sudo make install
  33
  34 Add the following line to your Emacs startup file such as ~/.emacs.
  35
  36   (autoload 'riece "riece" "Start Riece" t)
  37
  38 If you are using XEmacs and want to install as a package, supply
  39 "--with-xemacs" option to the configure script and use
  40 "install-package" target instead of "install".
  41
  42 * Manuals
  43
  44 Info manuals are available after installation.  To read, start Emacs
  45 and type M-x info and select "Riece-en".
  46
  47 * Bug reports
  48
  49 If you write a bug report, please send them to the Liece Mailing List
  50 (liece@unixuser.org).