7f7ed076f5b033df1b7f024c3cfa02b6dabbf389
[riece] / README
1 * What's this?
2
3 Riece is an IRC client for Emacs.  The development has started to
4 redesign the Liece IRC client.
5
6 Riece provides the following features:
7
8 - Several IRC servers may be used at the same time.
9 - Essential features can be built upon the extension framework (called
10   "add-on") capable of dependency tracking.
11 - Installation is easy.  Riece doesn't depend on other packages.
12 - Setup is easy.  Automatically save/restore the configuration.
13 - Riece uses separate windows to display users, channels, and
14   dialogues.  The user can select the window layout.
15 - Step-by-step instructions (in info format) are included.
16 - Mostly compliant with RFC 2812.
17
18 * Directory tree
19
20 This package contains following directories:
21
22 lisp/ - Emacs Lisp files.
23 doc/  - Documentation files.
24
25 * Requirements
26
27 - Emacs 20.7 or later / XEmacs 21.4 or later
28 - Ruby 1.6 or later (optional)
29
30 * Installation
31
32 $ ./configure
33 $ sudo make install
34
35 If you are using XEmacs and want to install as a package, supply
36 "--with-xemacs" option to the configure script and use
37 "install-package" target instead of "install".
38
39 * Bug reports
40
41 If you write bug reports and/or suggestions for improvement, 
42 please send them to the Liece Mailing List.
43
44 This mailing list is also for other general discussions (about
45 future enhancements, customization, etc). To join the Liece ML,
46 send an e-mail to:
47
48      liece-ctl@unixuser.org
49
50 with the message body, 
51
52      subscribe Your Name