X-Git-Url: http://cgit.sxemacs.org/?p=riece;a=blobdiff_plain;f=README;h=b80dfa72e6c53a80f77fbad00349033de1a90a15;hp=09ae860652c2a3691e850422a9dbd43c3a9cdcad;hb=a276a2a33ae21ebef38bdd8aa6ef93b088f13e77;hpb=b8206b2e229f3dc9d315658228c1d3cf2be32eb6;ds=sidebyside diff --git a/README b/README index 09ae860..b80dfa7 100644 --- a/README +++ b/README @@ -1,29 +1,50 @@ * What's this? -Riece is a redesign of the Liece IRC client. +Riece is an IRC client for Emacs. -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 (in info format) are included. +- Mostly compliant with RFC 2812. * Directory tree This package contains following directories: lisp/ - Emacs Lisp files. - doc/ - Documentation files. -* Bug reports +* Requirements + +- Emacs 20.7 or later / XEmacs 21.4 or later +- Ruby 1.8 or later (optional) + +* Installation -If you write bug reports and/or suggestions for improvement, -please send them to the Liece Mailing List. +$ ./configure +$ sudo make install -This mailing list is also for other general discussions (about -future enhancements, customization, etc). To join the Liece ML, -send an e-mail to: +Add the following line to your Emacs startup file such as ~/.emacs. - liece-ctl@unixuser.org + (autoload 'riece "riece" "Start Riece" t) -with the message body, +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". + +* Manuals + +Info manuals are available after installation. To read, start Emacs +and type M-x info and select "Riece-en". + +* Bug reports - subscribe Your Name +If you write a bug report, please send them to the Liece Mailing List +(liece@unixuser.org).