docs/readme.mdwn
author Myhailo Danylenko <isbear@ukrpost.net>
Sat, 05 Mar 2016 15:43:04 +0200
changeset 59 19cfaceda6bb
parent 54 6bef2082e5f9
permissions -rw-r--r--
ssl: Add ssl:ca_path and ssl:cipher_list methods (v0.9.4)


# Loudmouth interface for lua

This interface to loudmouth XMPP client library for lua 5.1 or 5.2.

Main loudmouth project is now unmaintained, but mcabber community keeps
working version with some improvements at
<http://github.com/mcabber/loudmouth>.

Test script depends on my glib module, and thus is unusable as is.
Still, it is a good example of how things are working.

This module should be used as follows:
lm = require 'lm'
i.e., you should assign return value of *require* to some variable.

Loudmouth uses glib main loop to work, thus you should use this module 
in a glib loop environment, provided either by your glib-based program
or by some other module, eg lua binding for gtk+ or my glib module.

# Installation

To install it, you need:

 * lua (optional, to run test)
 * liblua headers and library
 * glib headers and library
 * loudmouth headers and library
 * cmake
 * c compiler (gcc)
 * linker (binutils)
 * pkg-config (to detect glib and loudmouth)
 * perl (optional, to generate documentation)

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 lua5.?-loudmouth_*.deb

Users of other systems can set other CPack 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>