* README: Updated to match the content of the ejabberd Guide

SVN Revision: 1206

diff --git a/ChangeLog b/ChangeLog
index c947a8ee3a5630a242c5eed662dbedd5e15274ce..ec3d3025d815e2b265f2e9e1927ef00417dff8f9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,7 @@
 2008-02-20  Badlop  <badlop@process-one.net>
 
+       * README: Updated to match the content of the ejabberd Guide
+
        * doc/release_notes_2.0.0.txt: Updated version number and date
 
        * doc/guide.tex: Mentioned the problems about Windows service

diff --git a/README b/README
index 8712de6fa59bd5221c8f93da860a74be9af0a181..e4940246f54195c0e6916a0fcfbad8b55aa2ff56 100644 (file)
--- a/README
+++ b/README
@@ -2,37 +2,48 @@ ejabberd - High-Performance Enterprise Instant Messaging Server
 
 Quickstart guide
 
-0. Dependancies
 
-To build ejabberd, you need:
+0. Requirements
+
+To compile ejabberd you need:
  - GNU Make
  - GCC
  - libexpat 1.95 or higher
- - Erlang/OTP R9C-2 or higher
- - OpenSSL 0.9.6 or higher (optional)
- - Zlib 1.2.3 or higher (optional)
- - GNU Iconv 1.8 or higher (optional, not needed on systems with GNU libc)
+ - Erlang/OTP R10B-9 up to R11B-5. Erlang R12 releases are not yet
+   officially supported, and are not recommended for production
+   servers
+ - OpenSSL 0.9.6 or higher, for STARTTLS, SASL and SSL
+   encryption. Optional, highly recommended.
+ - Zlib 1.2.3 or higher, for Stream Compression support
+   (XEP-0138). Optional.
+ - GNU Iconv 1.8 or higher, for the IRC Transport
+   (mod_irc). Optional. Not needed on systems with GNU Libc.
+
+
+1. Compile and install on *nix systems
 
-1. Build and install on *nix systems
+To compile ejabberd, go to the directory src/ and execute the commands:
+  ./configure
+  make
 
-To build ejabberd, please go into the src directory and type the 
-following commands:
- ./configure && make
- sudo make install
+To install ejabberd, run this command with system administrator rights
+(root user):
+
+  sudo make install
 
 These commands will:
- - install a startup script into the directory /usr/sbin,
- - install ejabberd into the directory /var/lib/ejabberd,
- - install the configuration file into /etc/ejabberd,
- - create a directory called /var/log/ejabberd to store log files.
+ - Install a startup script: /sbin/ejabberdctl
+ - Install ejabberd in /var/lib/ejabberd/
+ - Install the configuration files in /etc/ejabberd/
+ - Create a directory for log files: /var/log/ejabberd/
+
 
-Note: "sudo make install" means that the "make install" command should
-      be run with system administrator rights (root).
+2. Start ejabberd
 
-2. Run
+You can use the ejabberdctl command line administration script to
+start and stop ejabberd. For example:
+  ejabberdctl start
 
-To run ejabberd, type the following command:
- erl -pa /var/lib/ejabberd/ebin -sname ejabberd -s ejabberd
 
-For detailled informations, please refer to:
-http://www.process-one.net/en/projects/ejabberd/docs/guide_en.html
+For detailed information please refer to the
+ejabberd Installation and Operation Guide