README: some more docs, still incomplete

1 files changed, 45 insertions, 1 deletions

diff --git a/skype/README b/skype/README
index 4143cbf4..387ae3f9 100644
--- a/skype/README
+++ b/skype/README
@@ -1,3 +1,41 @@
+Hello,
+
+This plugin allows you to add Skype support to BitlBee. It's mainly written by
+Miklos Vajna <vmiklos@frugalware.org>.
+
+How to set it up:
+
+- You need the BitlBee bzr branch:
+
+bzr branch http://code.bitlbee.org/bitlbee/
+
+- You need to enable plugin support:
+
+http://frugalware.org/~vmiklos/patches/bitlbee-configure-plugins.patch
+
+- To be able to do an install-dev:
+
+http://frugalware.org/~vmiklos/patches/bitlbee-makefile-headers.patch
+
+- Now compile and install it:
+
+./configure --prefix=/usr
+make
+make install install-dev
+
+- Get the plugin code:
+
+git clone http://ftp.frugalware.org/pub/other/people/vmiklos/bitlbee-skype
+
+- Compile and install it:
+
+make
+cp skype.so /usr/lib/bitlbee
+
+- Set up the tcp server:
+
+FIXME
+
 What works:
 
 - Download nicks and away statuses from Skype
@@ -6,7 +44,9 @@ What works:
 
 - Receiving messages
 
-What needs to be done:
+What needs to be done (aka. TODO):
+
+- import the daemon code
 
 - mark received messages as read so that skype won't say there are unread messages
 
@@ -18,6 +58,10 @@ What needs to be done:
 
 - maybe on account on/off, change our state from/to offline? so that we won't miss any message
 
+- handle the case when the tcp server is not running (currently SIGPIPE is not handled at all by the plugin)
+
+If something does not work and it's not in the TODO section, then please contact me!
+
 Shots at:
 
 http://frugalware.org/~vmiklos/pics/shots/bitlbee-skype/