docs/readme.mdwn
changeset 32 bea3464128d0
parent 3 d792ad17832e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/readme.mdwn	Tue Aug 21 03:14:48 2012 +0300
@@ -0,0 +1,51 @@
+
+# Operations on multiple buddies for MCabber
+
+This is mcabber module to do the same command on several contacts.
+
+Useful example binding for '/mark toggle' is provided in 'marking.rc'.
+After you marked some buddies, you can then run '/marked do <command>'
+to do 'command' with each of marked buddies jid's. 'command' must
+contain one %s where jid should be inserted. Any other %'s should be
+escaped as '%%'.
+
+# Installation
+
+To install it, you need:
+
+ * mcabber headers
+ * glib
+ * cmake
+ * make
+ * c compiler (gcc)
+ * linker (binutils)
+
+Then do:
+
+    $ mkdir build
+    $ cd build
+    $ cmake ..
+    $ make edit_cache
+    $ make
+    # make install
+
+Debian users can instead of make install do:
+
+    $ make package
+    # dpkg -i libmcabber-marking_*.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/>.
+
+# Contact
+
+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>