25
1
mirror of https://github.com/processone/ejabberd.git synced 2024-12-26 17:38:45 +01:00

Merge pull request #189 from weiss/markdown-readme

Convert README to Markdown
This commit is contained in:
Evgeny Khramtsov 2014-04-30 07:55:27 +04:00
commit ce22239d85
2 changed files with 25 additions and 13 deletions

29
README
View File

@ -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
@ -21,8 +25,10 @@ To compile ejabberd you need:
1. Compile and install on *nix systems
--------------------------------------
To compile ejabberd execute the commands:
./configure
make
@ -32,20 +38,25 @@ To install ejabberd, run this command with system administrator rights
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
For detailed information please refer to the
ejabberd Installation and Operation Guide
For detailed information please refer to the [ejabberd Installation and
Operation Guide][1].
[1]: http://www.process-one.net/docs/ejabberd/guide_en.html

1
README.md Symbolic link
View File

@ -0,0 +1 @@
README