[Telepathy-commits] [mingle/master] Add an initial readme

[Sjoerd Simons]

---
 README |   35 +++++++++++++++++++++++++++++++++++
 1 files changed, 35 insertions(+), 0 deletions(-)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..42dce55
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+Python demo for the Mingle protocol
+
+Requirements:
+  - nice >= 0.0.3 (for ICE support), http://nice.freedesktop.org/
+    with patches 0671c485e087c5d656053f348037a3235e414701 and
+    cb7d3ba01d59d0db342f04ab7cf5640c2c1d1e82 from the revert-netbuffer branch
+    in git://git.collabora.co.uk/git/user/tester/nice.git (should be merged
+    upstream rsn.)
+  - farsight 2 >= 0.0.4, http://farsight.freedesktop.org/
+  - twisted, twisted words and twisted names, http://twistedmatrix.com/
+  - pygobject with the patch from
+    http://bugzilla.gnome.org/show_bug.cgi?id=530935
+
+Usage:
+- jingle-gui.py <JID> <PASSWORD>
+
+Start of a simple UI. Logs in as JID with password PASSWORD.  Currently just
+shows a list of people that are online on the given account
+
+- jingle-call.py <JID> <PASSWORD> [REMOTEJID]
+
+Simple program to make jingle calls. Logs in as JID with password PASSWORD and
+will then  listen for incoming jingle calls. Calls  REMOTEJID if given.
+
+- mingle-client.py <JID> <PASSWORD> <CONFERENCEJID>
+
+Simple demonstration program for mingle. Logs in as JID with password PASSWORD
+and will join/start a mingle conference at CONFERENCEJID (e.g.
+mingle at conference.jabber.org)
+
+
+To use either mingle-client.py or jingle-call.py with a webcam the VIDEO_DEVICE
+environment variable needs to be set (e.g. VIDEO_DEVICE=/dev/video0). To use an
+audiotestsrc for audio input instead of a microphone set TESTAUDIO in the
+environment.
-- 
1.5.6.5