README
changeset 26 1f7e8b53b255
parent 24 1ad539cb8dc6
child 33 14f3430c43b6
equal deleted inserted replaced
25:1ce483608721 26:1f7e8b53b255
     2 This is a lua 5.1 interface for loudmouth jabber client library.
     2 This is a lua 5.1 interface for loudmouth jabber client library.
     3 
     3 
     4 INSTALLATION
     4 INSTALLATION
     5 
     5 
     6 To install it, you need:
     6 To install it, you need:
     7 - lua (in fact, optional, to run test, but for now CMake cannot detect liblua separately)
     7 - lua (optional, to run test)
     8 - liblua headers and library
     8 - liblua headers and library
     9 - glib headers and library
     9 - glib headers and library
    10 - loudmouth headers and library
    10 - loudmouth headers and library
    11 - cmake
    11 - cmake
    12 - pkg-config (to detect glib and loudmouth)
    12 - pkg-config (to detect glib and loudmouth)
    22 
    22 
    23 Debian users can instead of make install do,
    23 Debian users can instead of make install do,
    24 $ fakeroot make package
    24 $ fakeroot make package
    25 # dpkg -i liblua5.1-*.deb
    25 # dpkg -i liblua5.1-*.deb
    26 
    26 
    27 Users of other systems can set other CPack generator wich cache editor.
    27 Users of other systems can set other CPack generator using cache editor.
    28 
    28 
    29 NOTES
    29 NOTES
    30 
    30 
    31 Unfortunately, test script depends on my unfinished (and, probably, never finished)
    31 Unfortunately, test script depends on my unfinished (and, probably, never finished)
    32 glib module, and thus is unusable as is.
    32 glib module, and thus is unusable as is.
    33 
    33 
    34 This module should be used as follows:
    34 This module should be used as follows:
    35 lm = require 'lm'
    35 lm = require 'lm'
    36 i.e., you should assign require return value to some variable.
    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+.
    37 
    41 
    38 LICENSE
    42 LICENSE
    39 
    43 
    40 This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
    44 This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
    41 from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
    45 from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.