diff options
author | Evgeny Khramtsov <xramtsov@gmail.com> | 2014-04-30 07:55:27 +0400 |
---|---|---|
committer | Evgeny Khramtsov <xramtsov@gmail.com> | 2014-04-30 07:55:27 +0400 |
commit | ce22239d851cd9162541da2b4ef46ac78f03faf0 (patch) | |
tree | 84c14ce23db6ec570cb3dffe9ce5e09c6271b987 | |
parent | Merge pull request #177 from weiss/log-tls-sasl-external (diff) | |
parent | Convert README to Markdown (diff) |
Merge pull request #189 from weiss/markdown-readme
Convert README to Markdown
-rw-r--r-- | README | 37 | ||||
l--------- | README.md | 1 |
2 files changed, 25 insertions, 13 deletions
@@ -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,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 diff --git a/README.md b/README.md new file mode 120000 index 00000000..100b9382 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +README
\ No newline at end of file |