jacob.eva
/
ejabberd-contrib
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README.md: Apply cosmetic changes

This commit is contained in:
Holger Weiss 2015-04-22 23:48:31 +02:00
parent 362a896e6a
commit 73b984f193
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -10,18 +10,22 @@ For users
To use an ejabberd module coming from this repository: To use an ejabberd module coming from this repository:
- You need to have Ejabberd installed. - You need to have ejabberd installed.
- Run `ejabberdctl module_install <module>` to get the sources, compile and - Run `ejabberdctl module_install <module>` to get the source code and to
install the beams file in ejabberd path. This path is either ~/.ejabberd-modules compile and install the `beam` file into ejabberd's module search path.
or defined by CONTRIB\_MODULES\_PATH in ejabberdctl.cfg. This path is either `~/.ejabberd-modules` or defined by the
`CONTRIB_MODULES_PATH` setting in `ejabberdctl.cfg`.
- Edit the configuration file provided in the `conf` dir of the installed - Edit the configuration file provided in the `conf` directory of the
module to update to your needs. Then apply the changes to your main ejabberd installed module and update it to your needs. Then apply the changes to
configuration. On future release, ejabberd will automatically add this file your main ejabberd configuration. In a future release, ejabberd will
to its runtime configuration without changes. automatically add this file to its runtime configuration without
changes.
- Run `ejabberdctl module_uninstall <module>` to remove a module from
ejabberd.
- Run `ejabberdctl module_uninstall <module>` to remove a module from ejabberd.
For developers For developers
-------------- --------------
@ -29,12 +33,12 @@ For developers
The following organization has been set up for the development: The following organization has been set up for the development:
- Development and compilation of modules is done by ejabberd. You need - Development and compilation of modules is done by ejabberd. You need
Ejabberd installed. Use `ejabberdctl module_check <module>` to ensure ejabberd installed. Use `ejabberdctl module_check <module>` to ensure it
it compiles correctly before commit your work. Sources of your module compiles correctly before committing your work. The sources of your
must be located in $CONTRIB\_MODULES\_PATH/sources/<module> module must be located in `$CONTRIB_MODULES_PATH/sources/<module>`.
- Compilation can by done manually (if you know what you are doing) - Compilation can by done manually (if you know what you are doing) so you
so you don't need ejabberd running: don't need ejabberd running:
``` ```
cd /path/of/module cd /path/of/module
mkdir ebin mkdir ebin