From c371d0f0713f6fa348bfb2974953e27742caa082 Mon Sep 17 00:00:00 2001 From: Simon McVittie Date: Wed, 8 Jan 2014 20:14:50 +0000 Subject: [PATCH] Flatten telepathy-farstream/README into the top-level README Also drop parts of telepathy-logger/README that are redundant with the top-level README. --- README | 29 +++++++++++++++++-- telepathy-farstream/README | 70 ---------------------------------------------- telepathy-logger/README | 9 ------ 3 files changed, 27 insertions(+), 81 deletions(-) delete mode 100644 telepathy-farstream/README diff --git a/README b/README index 3ad0ac5..a971617 100644 --- a/README +++ b/README @@ -2,13 +2,25 @@ telepathy-glib ============== -This is a library for GLib-based Telepathy components. - 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. +telepathy-glib is a C library using GLib, for use in Telepathy clients, +connection managers (protocol backends) and other components. It can +also be used from C++ via extern "C" linkage, and from higher-level +languages including Python and JavaScript via GObject-Introspection. + +Optional components: + +• telepathy-farstream implements the actual streaming for Telepathy + Call channels using Farstream and GStreamer, and should be used in + VoIP client user interfaces + +• telepathy-logger provides a logging daemon and a log-access library, + see telepathy-logger/README for more details + Telepathy specification ======================= @@ -37,6 +49,19 @@ See configure.ac for full details, including versions required. Of the packages listed above, only GLib, GObject, libdbus and dbus-glib are required at runtime. +The optional components additionally require: + + Farstream + GStreamer base plugins + sqlite + libxml2 + +Configure with --enable-farstream, --enable-logger to make the build +fail if suitable versions are not found, or --disable-farstream etc. to +disable an optional component even if its dependencies are present. +The default is to compile all optional components whose dependencies are +satisfied. + Building from git also requires the GNU build system (Autoconf, Automake, libtool). diff --git a/telepathy-farstream/README b/telepathy-farstream/README deleted file mode 100644 index 3a18752..0000000 --- a/telepathy-farstream/README +++ /dev/null @@ -1,70 +0,0 @@ -======================= -telepathy-farstream -======================= - -Telepathy Farstream is a Telepathy client library that uses Farstream -to handle Call channels. - -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-farstream requires: - telepathy-glib - Farstream - GStreamer base plugins - GLib, GObject - libdbus - The D-Bus GLib bindings - -At build time, it also requires: - GNU make - pkg-config - libxslt, xsltproc - Python - -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: - - -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: - - - - -Telepathy development is supported by Collabora Ltd. - . - -Hacking -======= - -The current version of telepathy-farstream is always available from: - - -Please follow . diff --git a/telepathy-logger/README b/telepathy-logger/README index 1f7336e..886734e 100644 --- a/telepathy-logger/README +++ b/telepathy-logger/README @@ -9,12 +9,3 @@ tp-logger features a Telepathy-style D-Bus API to expose logs and interesting information related to logging (most frequent contacts, etc.). It also provides a GLib-compatible client API for making bulk log requests (e.g. for display logs in applications without having to provide lots of information over D-Bus). - -TPL is currently under development, please refer to -http://telepathy.freedesktop.org/wiki/Logger for more information. - -Bugs should be filed at http://bugs.freedesktop.org/ under the product -`Telepathy' and the category `logger'. - -Telepathy discussion takes place on the Telepathy mailing list - or on irc.freenode.net/#telepathy -- 1.8.5.2