Add README

20080218153648-53eee-e4a9566921b4a9fbe34215d6bd768b8e3983d564.gz

1 files changed, 76 insertions, 0 deletions

diff --git a/README b/README
index e69de29b..0f9347c1 100644
--- a/README
+++ b/README
@@ -0,0 +1,76 @@
+================
+telepathy-salut
+================
+
+Gabble is a link-local XMPP ("Bonjour") connection manager for the Telepathy
+framework, currently supporting presence and single-user chats with iChat
+interoperability, and multi-user chats and Tubes using the Clique protocol.
+
+Telepathy is a D-Bus framework for unifying real time communication,
+including instant messaging, voice calls and video calls. It abstracts
+differences between protocols to provide a unified interface for
+applications.
+
+Requirements
+============
+
+telepathy-salut requires:
+  telepathy-glib <http://telepathy.freedesktop.org/releases/telepathy-glib/>
+  libxml2 <http://xmlsoft.org/>
+  avahi-client, avahi-glib <http://avahi.org/download/>
+  GLib, GObject <http://ftp.gnome.org/pub/GNOME/sources/glib/>
+  libdbus <http://dbus.freedesktop.org/releases/dbus/>
+  The D-Bus GLib bindings <http://dbus.freedesktop.org/releases/dbus-glib/>
+
+At build time, it also requires:
+  GNU make <http://www.gnu.org/software/make/>
+  pkg-config <http://ftp.gnome.org/pub/GNOME/sources/pkg-config/>
+  libxslt, xsltproc <http://xmlsoft.org/XSLT/>
+  Python <http://www.python.org/>
+and optionally makes use of:
+  Check <http://check.sourceforge.net/>
+
+See configure.ac for full details, including versions required.
+
+Building from Darcs also requires the GNU build system (Autoconf, Automake,
+libtool).
+
+Bugs, feature requests and to-do list
+=====================================
+
+Report all bugs, feature requests and "to-do" items here:
+  <https://bugs.freedesktop.org/enter_bug.cgi?product=Telepathy&component=telepathy-salut>
+
+Versioning policy
+=================
+
+We use an "odd/even" versioning scheme where the minor version (the y in
+x.y.z) determines stability - stable branches have y even, development
+branches have y odd.
+
+Unreleased builds straight from Darcs identify themselves as version
+"x.y.z.1". These are compiled with -Werror, so they might stop working
+if your gcc version issues more warnings than ours. If this is a problem
+for you, use a release tarball.
+
+Contact info
+============
+
+This package is maintained by the Telepathy project:
+  <http://telepathy.freedesktop.org/>
+  <mailto:telepathy@lists.freedesktop.org>
+  <irc://irc.freenode.net/telepathy>
+
+Telepathy development is supported by Collabora Ltd.
+  <http://www.collabora.co.uk/>.
+
+Hacking
+=======
+
+The current version of telepathy-salut is always available from:
+  <http://darcs.collabora.co.uk/darcs/telepathy-salut/>
+
+Proposed patches awaiting review can usually be found in Merge Monkey:
+  <http://monkey.collabora.co.uk/>
+
+Please follow <http://telepathy.freedesktop.org/wiki/Style> in new code.