docs/readme.mdwn
changeset 15 6222baf5dccc
parent 0 3f69962cbbf4
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/readme.mdwn	Mon Aug 20 17:13:45 2012 +0300
@@ -0,0 +1,49 @@
+
+# Uptime tracking for MCabber
+
+This is a mcabber module to track mcabber uptime. To do so you need
+either to have '/proc/self/stat', '/proc/uptime' and 'sysconf()'
+(probably, linux-specific) or load it at mcabber initialization time.
+
+To use first variant, set the 'uptime_use_proc' option.
+
+# 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-uptime_*.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>