diff -r f23b9521b4d6 -r 0477d4800fbd README --- a/README Wed Aug 08 14:43:55 2012 +0300 +++ b/README Mon Aug 20 18:53:05 2012 +0300 @@ -1,74 +1,1 @@ - -# Personal Eventing Protocol modules - -This is a set of modules, that provide notfication about other's events -and allow you to publish yours. - -Pep module provides common listener for incoming PEP events. - -Tune module provides '/tune' command to publish music, you are listening -to at the moment. However, it does not by itself does that. You'll need -some other module, that will provide music information, like 'mpd' one. -Alternatively, you can set up some scripts to publish information with -'/tune' command via fifo. - -Mood module provides '/mood' command to publish your current mood. -Currently it does not check for validity of its input, so, it's strongly -suggested to use provided completion for first argument. - -Geoloc module provides '/geoloc' command to publish your current location. -Currently, there are no known use cases of this module, but I hope, that -someday there will be a module, that will retrieve geolocation information -from devices and use this module to publish it. - -Activity module provides '/activity' command to publish your current activity. -Currently it does not check for validity of its input either, so, please -use completion for first two arguments. - -Note: In order for you to actually publish something, your server must -support PEP, and that is still not that widely available. Still, even -if your server does not, you can load modules to be notified about your -buddies events. - -All of the modules also provide C headers for other C modules to use -to publish data. Note, however, that I plan to switch to events interface -for that - it provides multiplexing ability, and in general is more -flexible. - -# Installation - -To install it, you need: -cmake -make -gcc -glib -loudmouth -mcabber's headers - -Then do -$ mkdir build -$ cd build -$ cmake .. -$ make edit_cache -$ make -# make install - -Debian users can instead of make install do -$ fakeroot make package -# dpkg -i libmcabber-pep*.deb - -Users of other distributions can select appropriate package -generator, using cache editor. - -# License - -This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING -from this distribution or on a GNU web-site . - -# Contacts - -I will be happy to get feedback, patches, suggestions, etc. -You can send me email or contact via jabber . - - -- Myhailo Danylenko - +docs/readme.mdwn \ No newline at end of file