* riece-commands.el (riece-command-close-server): Cause error
[riece] / README
diff --git a/README b/README
index 846067f..b80dfa7 100644 (file)
--- 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.
 
-dcc/  - DCC external program source.  (currently not used)
+* Requirements
 
-* Bug reports
+- Emacs 20.7 or later / XEmacs 21.4 or later
+- Ruby 1.8 or later (optional)
+
+* Installation
+
+$ ./configure
+$ sudo make install
 
-If you write bug reports and/or suggestions for improvement, 
-please send them to the Liece Mailing List.
+Add the following line to your Emacs startup file such as ~/.emacs.
 
-This mailing list is also for other general discussions (about
-future enhancements, customization, etc). To join the Liece ML,
-send an e-mail to:
+  (autoload 'riece "riece" "Start Riece" t)
 
-     liece-ctl@unixuser.org
+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".
 
-with the message body, 
+* 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).