Skip to content

Commit

Permalink
Convert README to Markdown
Browse files Browse the repository at this point in the history
Use Markdown syntax for the README file and add a README.md symlink, so
that a certain popular Git hosting site renders it nicely.
  • Loading branch information
weiss committed Apr 29, 2014
1 parent 9563b02 commit 375a1dd
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 13 deletions.
37 changes: 24 additions & 13 deletions README
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
ejabberd - High-Performance Enterprise Instant Messaging Server
---------------------------------------------------------------

Quickstart guide
================


0. Requirements
---------------

To compile ejabberd you need:

- GNU Make
- GCC
- Libexpat 1.95 or higher
Expand All @@ -21,31 +25,38 @@ To compile ejabberd you need:


1. Compile and install on *nix systems
--------------------------------------

To compile ejabberd execute the commands:
./configure
make

./configure
make

To install ejabberd, run this command with system administrator rights
(root user):

sudo make install
sudo make install

These commands will:
- Install the configuration files in /etc/ejabberd/
- Install ejabberd binary, header and runtime files in /lib/ejabberd/
- Install the administration script: /sbin/ejabberdctl
- Install ejabberd documentation in /share/doc/ejabberd/
- Create a spool directory: /var/lib/ejabberd/
- Create a directory for log files: /var/log/ejabberd/

- Install the configuration files in `/etc/ejabberd/`
- Install ejabberd binary, header and runtime files in `/lib/ejabberd/`
- Install the administration script: `/sbin/ejabberdctl`
- Install ejabberd documentation in `/share/doc/ejabberd/`
- Create a spool directory: `/var/lib/ejabberd/`
- Create a directory for log files: `/var/log/ejabberd/`


2. Start ejabberd
-----------------

You can use the ejabberdctl command line administration script to
You can use the `ejabberdctl` command line administration script to
start and stop ejabberd. For example:
ejabberdctl start

ejabberdctl start


For detailed information please refer to the [ejabberd Installation and
Operation Guide][1].

For detailed information please refer to the
ejabberd Installation and Operation Guide
[1]: http://www.process-one.net/docs/ejabberd/guide_en.html
1 change: 1 addition & 0 deletions README.md

0 comments on commit 375a1dd

Please sign in to comment.