docs/readme.mdwn
author Myhailo Danylenko <isbear@ukrpost.net>
Wed, 16 Mar 2016 01:53:56 +0200
changeset 66 a40beb82130c
parent 54 6bef2082e5f9
permissions -rw-r--r--
node: Use new loudmouth feature - public attribute list (v0.9.7)
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
     1
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
     2
# Loudmouth interface for lua
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
     3
54
6bef2082e5f9 v0.9.2 Support for lua 5.2
Myhailo Danylenko <isbear@ukrpost.net>
parents: 52
diff changeset
     4
This interface to loudmouth XMPP client library for lua 5.1 or 5.2.
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
     5
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
     6
Main loudmouth project is now unmaintained, but mcabber community keeps
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
     7
working version with some improvements at
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
     8
<http://github.com/mcabber/loudmouth>.
6
90073cbb535d Logging and chained methods
Myhailo Danylenko <isbear@ukrpost.net>
parents: 5
diff changeset
     9
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    10
Test script depends on my glib module, and thus is unusable as is.
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    11
Still, it is a good example of how things are working.
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    12
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    13
This module should be used as follows:
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    14
lm = require 'lm'
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    15
i.e., you should assign return value of *require* to some variable.
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    16
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    17
Loudmouth uses glib main loop to work, thus you should use this module 
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    18
in a glib loop environment, provided either by your glib-based program
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    19
or by some other module, eg lua binding for gtk+ or my glib module.
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    20
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    21
# Installation
23
13f03e604c8a License notes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 20
diff changeset
    22
11
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
    23
To install it, you need:
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    24
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    25
 * lua (optional, to run test)
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    26
 * liblua headers and library
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    27
 * glib headers and library
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    28
 * loudmouth headers and library
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    29
 * cmake
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    30
 * c compiler (gcc)
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    31
 * linker (binutils)
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    32
 * pkg-config (to detect glib and loudmouth)
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    33
 * perl (optional, to generate documentation)
11
a8c6460d612b Naming scheme change to more ld-friendly
Myhailo Danylenko <isbear@ukrpost.net>
parents: 6
diff changeset
    34
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    35
Then do: 
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    36
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    37
    $ mkdir build
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    38
    $ cd build
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    39
    $ cmake ..
52
c7031f15125d Fix readme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 49
diff changeset
    40
    $ make edit_cache
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    41
    $ make
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    42
    # make install
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    43
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    44
Debian users can instead of make install do:
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    45
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    46
    $ make package
54
6bef2082e5f9 v0.9.2 Support for lua 5.2
Myhailo Danylenko <isbear@ukrpost.net>
parents: 52
diff changeset
    47
    # dpkg -i lua5.?-loudmouth_*.deb
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    48
26
1f7e8b53b255 Detect lua interpreter presence for testing
Myhailo Danylenko <isbear@ukrpost.net>
parents: 24
diff changeset
    49
Users of other systems can set other CPack generator using cache editor.
20
0ce7093df25f Pre-publish changes
Myhailo Danylenko <isbear@ukrpost.net>
parents: 11
diff changeset
    50
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    51
# License
24
1ad539cb8dc6 Turn off debugging, note on require'ing
Myhailo Danylenko <isbear@ukrpost.net>
parents: 23
diff changeset
    52
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    53
This code underlies terms of GNU GPL v2 or later. You can find it in
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    54
file COPYING from this distribution or on a GNU web-site
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    55
<http://www.gnu.org/licenses/>.
26
1f7e8b53b255 Detect lua interpreter presence for testing
Myhailo Danylenko <isbear@ukrpost.net>
parents: 24
diff changeset
    56
49
4b9d1a7e6861 Update docs
Myhailo Danylenko <isbear@ukrpost.net>
parents: 48
diff changeset
    57
# Contact
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    58
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    59
I will be happy to get feedback, patches, suggestions, etc.
33
14f3430c43b6 Update contact jid
Myhailo Danylenko <isbear@ukrpost.net>
parents: 26
diff changeset
    60
You can send me email or contact via jabber <isbear@unixzone.org.ua>.
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    61
5
e617c9cf6dd3 Updates to build system
Myhailo Danylenko <isbear@ukrpost.net>
parents: 0
diff changeset
    62
  -- Myhailo Danylenko <isbear@ukrpost.net>
0
84fdfb0344c9 Initial commit
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
    63