docs/readme.mdwn
changeset 40 fbdae6975352
parent 23 2b7060ce1152
equal deleted inserted replaced
39:46a3adff42b5 40:fbdae6975352
       
     1 
       
     2 # PEP avatars for MCabber
       
     3 
       
     4 This is a module, implementing avatar publishing/retrieving via
       
     5 pep/pubsub. This module informs you, when your buddies publish their
       
     6 avatars via pep and provides command '/avatar' to publish your own.
       
     7 But this is not all. It also will show you buddy's avatar!
       
     8 Yes, it is aalib :)
       
     9 
       
    10 This module depends on module 'pep'.
       
    11 
       
    12 For this module to actually do something you should set the option
       
    13 'avatars_directory' - a place, where your buddy avatars will be saved.
       
    14 
       
    15 Note, that currently only pubsub-publishing of avatars is supported
       
    16 (retrieving too works only for pubsub, but there you will be at least
       
    17 informed of url, that you can use to view avatar manually). Thus, as
       
    18 standard states, that pubsub-published data must be image/png, your
       
    19 avatar should be in png format.
       
    20 
       
    21 To receive notifications you need only to load it (better at startup,
       
    22 as I had some problems otherwise due to server's caching features).
       
    23 Then when your buddy will change avatar, you will receive notification
       
    24 and new avatar will be downloaded, saved and printed to buddy's window.
       
    25 To publish avatar you need your server to support both pep and pubsub
       
    26 (many public jabber servers offer only pubsub or neither, while for
       
    27 example prosody in default debian's complectation supports only pep).
       
    28 
       
    29 You can use AAOPTS environment variable to set aalib operation options,
       
    30 like contrast, brightness, etc (you can change mcabber environment at
       
    31 run-time with 'env' module). For a list of options see aalib
       
    32 documentation: <http://aa-project.sourceforge.net/aalib/aalib_9.html>
       
    33 
       
    34 # Installation
       
    35 
       
    36 To install it, you need:
       
    37 
       
    38  * mcabber headers
       
    39  * mcabber-pep module headers
       
    40  * libpng
       
    41  * aalib
       
    42  * glib
       
    43  * loudmouth
       
    44  * cmake
       
    45  * make
       
    46  * c compiler (gcc)
       
    47  * linker (binutils)
       
    48 
       
    49 Then do:
       
    50 
       
    51     $ mkdir build
       
    52     $ cd build
       
    53     $ cmake ..
       
    54     $ make edit_cache
       
    55     $ make
       
    56     # make install
       
    57 
       
    58 Debian users can instead of make install do:
       
    59 
       
    60     $ make package
       
    61     # dpkg -i libmcabber-avatar_*.deb
       
    62 
       
    63 Users of other distributions can select appropriate package generator,
       
    64 using cache editor.
       
    65 
       
    66 # License
       
    67 
       
    68 This code underlies terms of GNU GPL v2 or later. You can find it in
       
    69 file COPYING from this distribution or on a GNU web-site
       
    70 <http://www.gnu.org/licenses/>.
       
    71 
       
    72 # Contact
       
    73 
       
    74 I will be happy to get feedback, patches, suggestions, etc.
       
    75 You can send me email or contact via jabber <isbear@unixzone.org.ua>.
       
    76 
       
    77   -- Myhailo Danylenko <isbear@ukrpost.net>
       
    78