* README: Added this file as a quickstart guide.

SVN Revision: 697

diff --git a/ChangeLog b/ChangeLog
index 946169075bab5ee234630163e51eff5924f2e6af..2ae77e89a19e679e371621aba62eacdedf5bd8dd 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2006-12-16  Mickael Remond  <mickael.remond@process-one.net>
+
+       * README: Added this file as a quickstart guide.
+
 2006-12-15  Mickael Remond  <mickael.remond@process-one.net>
 
        * src/mod_echo.erl: The mod_echo can now be stopped without errors.

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..8712de6
--- /dev/null
+++ b/README
@@ -0,0 +1,38 @@
+ejabberd - High-Performance Enterprise Instant Messaging Server 
+
+Quickstart guide
+
+0. Dependancies
+
+To build 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)
+
+1. Build and install on *nix systems
+
+To build ejabberd, please go into the src directory and type the 
+following commands:
+ ./configure && make
+ 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.
+
+Note: "sudo make install" means that the "make install" command should
+      be run with system administrator rights (root).
+
+2. Run
+
+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