From: Drew Fisher <drew.m.fisher@gmail.com>
Date: Thu, 17 Apr 2014 05:20:32 +0000 (-0700)
Subject: Add minimal README
X-Git-Url: http://git.zarvox.org/static/%7Bthis.props.bicon_url%7D?a=commitdiff_plain;h=570574eb9c675ddbf550e744f41942073f737e84;p=imoo.git

Add minimal README
---

diff --git a/ribbon/README b/ribbon/README
new file mode 100644
index 0000000..743ac44
--- /dev/null
+++ b/ribbon/README
@@ -0,0 +1,23 @@
+Ribbon is a socket-controlled libpurple client.
+
+At present, it uses Qt5, libpurple, and relies on Qt's glib eventloop
+integration.  As a result, it only really compiles and runs conveniently on
+Linux.
+
+It reads account credentials from a text file at the moment, since I haven't
+actually implemented command dispatching.  You'll want to write your own
+three-line account.txt (or just not click the Sign In button):
+
+prpl-aim
+zarvoxthezadvook
+<not my real password>
+
+Then, if you have qt5 and libpurple installed and available to pkg-config,
+
+    qmake-qt5 ribbon.pro
+    make
+    ./ribbon
+
+Ribbon listens for JSON commands on port 8888.  It allows only one connection
+at a time, which makes sense since it should only be controlled by a single
+parent.