X-Git-Url: https://cgit.sxemacs.org/?p=riece;a=blobdiff_plain;f=README;h=d1cc489afbe4904491d3e3ba91ee33aebddb38d4;hp=846067f1bc26b44f5bfb282d6c6491b6a33334c2;hb=a4172314ca68caab7e2cef48323d0e296141b18d;hpb=fe7ce5e9a344721b1ecdd4d9ec1adce5dc908a49 diff --git a/README b/README index 846067f..d1cc489 100644 --- a/README +++ b/README @@ -1,17 +1,40 @@ * What's this? -Riece is a redesign of the Liece IRC client. +Riece is an IRC client for Emacs. The development has started to +redesign the Liece IRC client. -Note that the letter "R" means not only "redesign" but also "radical -development version". Please use at your own risk :-) +Riece provides the following features: + +- Several IRC servers may be used at the same time. +- Essential features can be built upon the extension framework (called + "add-on") capable of dependency tracking. +- Installation is easy. Riece doesn't depend on other packages. +- Setup is easy. Automatically save/restore the configuration. +- Riece uses separate windows to display users, channels, and + dialogues. The user can select the window layout. +- Step-by-step instructions (currently written in Japanese) are included. +- Mostly compliant with RFC 2812. * Directory tree This package contains following directories: lisp/ - Emacs Lisp files. +doc/ - Documentation files. + +* Requirements + +- Emacs 20.7 or later / XEmacs 21.4 or later +- Ruby 1.6 or later (optional) + +* Installation + +$ ./configure +$ sudo make install -dcc/ - DCC external program source. (currently not used) +If you are using XEmacs and want to install as a package, supply +"--with-xemacs" option to the configure script and use +"install-package" target instead of "install". * Bug reports