docs/readme.mdwn
changeset 49 4b9d1a7e6861
parent 48 ef69edc792be
child 52 c7031f15125d
equal deleted inserted replaced
48:ef69edc792be 49:4b9d1a7e6861
     1 
     1 
     2 This is a lua 5.1 interface for loudmouth jabber client library.
     2 # Loudmouth interface for lua
     3 
     3 
     4 INSTALLATION
     4 This interface to loudmouth XMPP client library for lua 5.1.
       
     5 
       
     6 Main loudmouth project is now unmaintained, but mcabber community keeps
       
     7 working version with some improvements at
       
     8 <http://github.com/mcabber/loudmouth>.
       
     9 
       
    10 Test script depends on my glib module, and thus is unusable as is.
       
    11 Still, it is a good example of how things are working.
       
    12 
       
    13 This module should be used as follows:
       
    14 lm = require 'lm'
       
    15 i.e., you should assign return value of *require* to some variable.
       
    16 
       
    17 Loudmouth uses glib main loop to work, thus you should use this module 
       
    18 in a glib loop environment, provided either by your glib-based program
       
    19 or by some other module, eg lua binding for gtk+ or my glib module.
       
    20 
       
    21 # Installation
     5 
    22 
     6 To install it, you need:
    23 To install it, you need:
     7 - lua (optional, to run test)
       
     8 - liblua headers and library
       
     9 - glib headers and library
       
    10 - loudmouth headers and library
       
    11 - cmake
       
    12 - pkg-config (to detect glib and loudmouth)
       
    13 - perl (optional, to generate documentation)
       
    14 
    24 
    15 Then do
    25  * lua (optional, to run test)
    16 $ mkdir build
    26  * liblua headers and library
    17 $ cd build
    27  * glib headers and library
    18 $ cmake ..
    28  * loudmouth headers and library
    19 $ cmake edit_cache
    29  * cmake
    20 $ make
    30  * c compiler (gcc)
    21 # make install
    31  * linker (binutils)
       
    32  * pkg-config (to detect glib and loudmouth)
       
    33  * perl (optional, to generate documentation)
    22 
    34 
    23 Debian users can instead of make install do,
    35 Then do: 
    24 $ fakeroot make package
    36 
    25 # dpkg -i liblua5.1-*.deb
    37     $ mkdir build
       
    38     $ cd build
       
    39     $ cmake ..
       
    40     $ cmake edit_cache
       
    41     $ make
       
    42     # make install
       
    43 
       
    44 Debian users can instead of make install do:
       
    45 
       
    46     $ make package
       
    47     # dpkg -i liblua5.1-loudmouth_*.deb
    26 
    48 
    27 Users of other systems can set other CPack generator using cache editor.
    49 Users of other systems can set other CPack generator using cache editor.
    28 
    50 
    29 NOTES
    51 # License
    30 
    52 
    31 Unfortunately, test script depends on my unfinished (and, probably, never finished)
    53 This code underlies terms of GNU GPL v2 or later. You can find it in
    32 glib module, and thus is unusable as is.
    54 file COPYING from this distribution or on a GNU web-site
       
    55 <http://www.gnu.org/licenses/>.
    33 
    56 
    34 This module should be used as follows:
    57 # Contact
    35 lm = require 'lm'
       
    36 i.e., you should assign require return value to some variable.
       
    37 
       
    38 Loudmouth uses glib main loop to work, thus you should use this module in
       
    39 a glib loop environment, provided either by your glib-based program or by some
       
    40 other module, eg lua binding for gtk+.
       
    41 
       
    42 LICENSE
       
    43 
       
    44 This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
       
    45 from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
       
    46 
       
    47 CONTACTS
       
    48 
    58 
    49 I will be happy to get feedback, patches, suggestions, etc.
    59 I will be happy to get feedback, patches, suggestions, etc.
    50 You can send me email or contact via jabber <isbear@unixzone.org.ua>.
    60 You can send me email or contact via jabber <isbear@unixzone.org.ua>.
    51 
    61 
    52   -- Myhailo Danylenko <isbear@ukrpost.net>
    62   -- Myhailo Danylenko <isbear@ukrpost.net>