1 

     2 # Lua scripting for MCabber

     3 

     4 This module creates lua interpreter environment and puts some lua

     5 functions in it to interact with mcabber. Module provides command 'lua'

     6 to run lua expressions in that environment.

     7 

     8 Lua interface is available in api reference, built with 'docgen' help.

     9 It is also available online.

    10 

    11 In 'examples' dir there are some example scripts, that may be used as

    12 is or for reference. See also 'README' in 'examples' dir.

    13 

    14 # Installation

    15 

    16 To install it, you need:

    17 

    18  * mcabber headers

    19  * liblua

    20  * glib

    21  * gmodule

    22  * docgen (optional, for documentation)

    23  * cmake

    24  * make

    25  * c compiler (gcc)

    26  * linker (binutils)

    27 

    28 Then do:

    29 

    30     $ mkdir build

    31     $ cd build

    32     $ cmake ..

    33     $ make edit_cache

    34     $ make

    35     # make install

    36 

    37 Debian users can instead of make install do:

    38 

    39     $ make package

    40     # dpkg -i libmcabber-lua_*.deb

    41 

    42 Users of other distributions can select appropriate package generator,

    43 using cache editor.

    44 

    45 # License

    46 

    47 This code underlies terms of GNU GPL v2 or later. You can find it in

    48 file COPYING from this distribution or on a GNU web-site

    49 <http://www.gnu.org/licenses/>.

    50 

    51 # Contact

    52 

    53 I will be happy to get feedback, patches, suggestions, etc.

    54 You can send me email or contact via jabber <isbear@unixzone.org.ua>.

    55 

    56   -- Myhailo Danylenko <isbear@ukrpost.net>

    57