README
author Myhailo Danylenko <isbear@ukrpost.net>
Tue, 19 May 2009 17:35:16 +0300
changeset 24 1ad539cb8dc6
parent 23 13f03e604c8a
child 26 1f7e8b53b255
permissions -rw-r--r--
Turn off debugging, note on require'ing
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     1
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     2
This is a lua 5.1 interface for loudmouth jabber client library.
6
90073cbb535d Logging and chained methods
Myhailo Danylenko <isbear@ukrpost.net>
parents: 5
diff changeset
     3
23
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
     4
INSTALLATION
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
     5
11
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
     6
To install it, you need:
20
0ce7093df25f Pre-publish changes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
     7
- lua (in fact, optional, to run test, but for now CMake cannot detect liblua separately)
11
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
     8
- liblua headers and library
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
     9
- glib headers and library
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
    10
- loudmouth headers and library
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
    11
- cmake
20
0ce7093df25f Pre-publish changes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    12
- pkg-config (to detect glib and loudmouth)
0ce7093df25f Pre-publish changes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    13
- perl (optional, to generate documentation)
11
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
    14
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
    15
Then do
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
    16
$ mkdir build
6
90073cbb535d Logging and chained methods
Myhailo Danylenko <isbear@ukrpost.net>
parents: 5
diff changeset
    17
$ cd build
90073cbb535d Logging and chained methods
Myhailo Danylenko <isbear@ukrpost.net>
parents: 5
diff changeset
    18
$ cmake ..
11
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
    19
$ cmake edit_cache
6
90073cbb535d Logging and chained methods
Myhailo Danylenko <isbear@ukrpost.net>
parents: 5
diff changeset
    20
$ make
90073cbb535d Logging and chained methods
Myhailo Danylenko <isbear@ukrpost.net>
parents: 5
diff changeset
    21
# make install
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    22
20
0ce7093df25f Pre-publish changes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    23
Debian users can instead of make install do,
11
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
    24
$ fakeroot make package
6
90073cbb535d Logging and chained methods
Myhailo Danylenko <isbear@ukrpost.net>
parents: 5
diff changeset
    25
# dpkg -i liblua5.1-*.deb
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    26
20
0ce7093df25f Pre-publish changes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    27
Users of other systems can set other CPack generator wich cache editor.
0ce7093df25f Pre-publish changes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    28
23
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    29
NOTES
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    30
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    31
Unfortunately, test script depends on my unfinished (and, probably, never finished)
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    32
glib module, and thus is unusable as is.
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    33
24
1ad539cb8dc6 Turn off debugging, note on require'ing
Myhailo Danylenko <isbear@ukrpost.net>
parents: 23
diff changeset
    34
This module should be used as follows:
1ad539cb8dc6 Turn off debugging, note on require'ing
Myhailo Danylenko <isbear@ukrpost.net>
parents: 23
diff changeset
    35
lm = require 'lm'
1ad539cb8dc6 Turn off debugging, note on require'ing
Myhailo Danylenko <isbear@ukrpost.net>
parents: 23
diff changeset
    36
i.e., you should assign require return value to some variable.
1ad539cb8dc6 Turn off debugging, note on require'ing
Myhailo Danylenko <isbear@ukrpost.net>
parents: 23
diff changeset
    37
23
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    38
LICENSE
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    39
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    40
This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    41
from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    42
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    43
CONTACTS
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    44
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    45
I will be happy to get feedback, patches, suggestions, etc.
23
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    46
You can send me email or contact via jabber <isbear@jabber.kiev.ua>.
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    47
5
e617c9cf6dd3 Updates to build system
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    48
  -- Myhailo Danylenko <isbear@ukrpost.net>
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    49