docs/readme.mdwn
author Myhailo Danylenko <isbear@ukrpost.net>
Tue, 21 Aug 2012 15:32:19 +0300
changeset 129 ea30cf6c5bea
parent 93 README@0a10228296c1
child 144 690b5524b895
permissions -rw-r--r--
Rearrange documentation


# Lua scripting for MCabber

This module creates lua interpreter environment and puts some lua
functions in it to interact with mcabber. Module provides command 'lua'
to run lua expressions in that environment.

Lua interface is available in api reference, built with 'docgen' help.
It is also available online.

In 'examples' dir there are some example scripts, that may be used as
is or for reference. See also 'README' in 'examples' dir.

# Installation

To install it, you need:

 * mcabber headers
 * liblua
 * glib
 * gmodule
 * docgen (optional, for documentation)
 * cmake
 * make
 * c compiler (gcc)
 * linker (binutils)

Then do:

    $ mkdir build
    $ cd build
    $ cmake ..
    $ make edit_cache
    $ make
    # make install

Debian users can instead of make install do:

    $ make package
    # dpkg -i libmcabber-lua_*.deb

Users of other distributions can select appropriate package generator,
using cache editor.

# License

This code underlies terms of GNU GPL v2 or later. You can find it in
file COPYING from this distribution or on a GNU web-site
<http://www.gnu.org/licenses/>.

# Contact

I will be happy to get feedback, patches, suggestions, etc.
You can send me email or contact via jabber <isbear@unixzone.org.ua>.

  -- Myhailo Danylenko <isbear@ukrpost.net>