docs/readme.mdwn
changeset 48 ef69edc792be
parent 33 14f3430c43b6
child 49 4b9d1a7e6861
equal deleted inserted replaced
47:4bf7ef2fea2e 48:ef69edc792be
       
     1 
       
     2 This is a lua 5.1 interface for loudmouth jabber client library.
       
     3 
       
     4 INSTALLATION
       
     5 
       
     6 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 
       
    15 Then do
       
    16 $ mkdir build
       
    17 $ cd build
       
    18 $ cmake ..
       
    19 $ cmake edit_cache
       
    20 $ make
       
    21 # make install
       
    22 
       
    23 Debian users can instead of make install do,
       
    24 $ fakeroot make package
       
    25 # dpkg -i liblua5.1-*.deb
       
    26 
       
    27 Users of other systems can set other CPack generator using cache editor.
       
    28 
       
    29 NOTES
       
    30 
       
    31 Unfortunately, test script depends on my unfinished (and, probably, never finished)
       
    32 glib module, and thus is unusable as is.
       
    33 
       
    34 This module should be used as follows:
       
    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 
       
    49 I will be happy to get feedback, patches, suggestions, etc.
       
    50 You can send me email or contact via jabber <isbear@unixzone.org.ua>.
       
    51 
       
    52   -- Myhailo Danylenko <isbear@ukrpost.net>
       
    53