1 

     1 docs/readme.mdwn

     2 # Personal Eventing Protocol modules

     3 

     4 This is a set of modules, that provide notfication about other's events

     5 and allow you to publish yours.

     6 

     7 Pep module provides common listener for incoming PEP events.

     8 

     9 Tune module provides '/tune' command to publish music, you are listening

    10 to at the moment. However, it does not by itself does that. You'll need

    11 some other module, that will provide music information, like 'mpd' one.

    12 Alternatively, you can set up some scripts to publish information with

    13 '/tune' command via fifo.

    14 

    15 Mood module provides '/mood' command to publish your current mood.

    16 Currently it does not check for validity of its input, so, it's strongly

    17 suggested to use provided completion for first argument.

    18 

    19 Geoloc module provides '/geoloc' command to publish your current location.

    20 Currently, there are no known use cases of this module, but I hope, that

    21 someday there will be a module, that will retrieve geolocation information

    22 from devices and use this module to publish it.

    23 

    24 Activity module provides '/activity' command to publish your current activity.

    25 Currently it does not check for validity of its input either, so, please

    26 use completion for first two arguments.

    27 

    28 Note: In order for you to actually publish something, your server must

    29 support PEP, and that is still not that widely available. Still, even

    30 if your server does not, you can load modules to be notified about your

    31 buddies events.

    32 

    33 All of the modules also provide C headers for other C modules to use

    34 to publish data. Note, however, that I plan to switch to events interface

    35 for that - it provides multiplexing ability, and in general is more

    36 flexible.

    37 

    38 # Installation

    39 

    40 To install it, you need:

    41 cmake

    42 make

    43 gcc

    44 glib

    45 loudmouth

    46 mcabber's headers

    47 

    48 Then do

    49 $ mkdir build

    50 $ cd build

    51 $ cmake ..

    52 $ make edit_cache

    53 $ make

    54 # make install

    55 

    56 Debian users can instead of make install do

    57 $ fakeroot make package

    58 # dpkg -i libmcabber-pep*.deb

    59 

    60 Users of other distributions can select appropriate package

    61 generator, using cache editor.

    62 

    63 # License

    64 

    65 This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING

    66 from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.

    67 

    68 # Contacts

    69 

    70 I will be happy to get feedback, patches, suggestions, etc.

    71 You can send me email or contact via jabber <isbear@unixzone.org.ua>.

    72 

    73   -- Myhailo Danylenko <isbear@ukrpost.net>

    74