README
changeset 40 fbdae6975352
parent 23 2b7060ce1152
--- a/README	Wed Aug 08 14:46:06 2012 +0300
+++ b/README	Mon Aug 20 20:37:24 2012 +0300
@@ -1,71 +1,1 @@
-
-This is a module, implementing avatar publishing/retrieving via pep/pubsub.
-This module informs you, when your buddies publish their avatars via pep
-and provides command '/avatar' to publish your own. But this is not all.
-It also will show you buddy's avatar! Yes, it is aalib :)
-
-This module depends on module 'pep'.
-
-For this module to actually do something you should set option
-avatars_directory - a place, where your buddy's avatars will be saved.
-
-Note, that currently only pubsub-publishing of avatars is supported
-(retrieving too works only for pubsub, but there you will be at least
-informed of url, that you can use to view avatar manually). Thus, as
-standard states, that pubsub-published data must be image/png, your
-avatar should be in png format.
-
-To receive notifications you need only to load it (better at startup, as
-I had some problems otherwise due to server's caching features). Then when
-your buddy will change avatar, you will receive notification and new
-avatar will be downloaded, saved and printed to buddy's window. To publish
-avatar you need your server to support both pep and pubsub (many public
-jabber servers offer only pubsub or neither, while for example prosody in
-default debian's complectation supports only pep).
-
-You can use AAOPTS environment variable to set aalib operation options, like
-contrast, brightness, etc (you can change mcabber environment at run-time
-with env module). For a list of options see aalib documentation:
-http://aa-project.sourceforge.net/aalib/aalib_9.html
-
-INSTALLATION
-
-To install it, you need:
-loudmouth
-glib
-aalib
-libpng
-mcabber's headers
-pep module's headers
-cmake
-make
-gcc
-
-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-avatar*.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 <http://www.gnu.org/licenses/>.
-
-CONTACTS
-
-I will be happy to get feedback, patches, suggestions, etc.
-You can send me email or contact via jabber <isbear@unixzone.org.ua>.
-
-  -- Myhailo Danylenko <isbear@ukrpost.net>
-
-
+docs/readme.mdwn
\ No newline at end of file