Warning, /telepathy-qt/README is written in an unsupported language. File is not indexed.

0001 =============
0002 telepathy-qt
0003 =============
0004 
0005 This is a library for Qt-based Telepathy clients and services.
0006 
0007 Telepathy is a D-Bus framework for unifying real time communication,
0008 including instant messaging, voice calls and video calls. It abstracts
0009 differences between protocols to provide a unified interface for
0010 applications. See the Telepathy website for more information:
0011 
0012   http://telepathy.freedesktop.org/
0013 
0014 Telepathy specification
0015 =======================
0016 
0017 The copy of the Telepathy specification in the spec/ directory indicates
0018 the specification that this library claims to implement. The HTML documentation for the latest version of the specification can be viewed at:
0019 
0020   http://telepathy.freedesktop.org/spec/
0021 
0022 Requirements
0023 ============
0024 
0025 Building telepathy-qt requires:
0026   Qt (DBus, Network and Xml for the library; Gui and Widgets are required for some examples) <https://www.qt.io>
0027 
0028   CMake <https://cmake.org/>
0029   pkg-config <https://pkg-config.freedesktop.org/>
0030   Python 3 <https://www.python.org/>
0031 
0032 For the full set of regression tests to run, you'll also need:
0033   telepathy-glib <https://telepathy.freedesktop.org/releases/telepathy-glib/>
0034 
0035 For building the Farsight convenience library, you'll need:
0036   telepathy-glib <https://telepathy.freedesktop.org/releases/telepathy-glib/>
0037   telepathy-farsight <https://telepathy.freedesktop.org/releases/telepathy-farsight/>
0038   GStreamer <https://gstreamer.freedesktop.org/>
0039 
0040 and to build the Farstream convenience library, you'll need:
0041   telepathy-glib <https://telepathy.freedesktop.org/releases/telepathy-glib/>
0042   telepathy-farstream <https://telepathy.freedesktop.org/releases/telepathy-farstream/>
0043   farstream <https://freedesktop.org/software/farstream/releases/>
0044   GStreamer <https://gstreamer.freedesktop.org/>
0045 
0046 See CMakeLists.txt for full details, including versions required.
0047 Of the packages listed above, only Qt libraries are required at runtime.
0048 
0049 Bugs, feature requests and to-do list
0050 =====================================
0051 
0052 Report all bugs, feature requests and "to-do" items here:
0053   <https://bugs.freedesktop.org/enter_bug.cgi?product=Telepathy&component=tp-qt>
0054 
0055 Running "make check" will produce FIXME.out, which lists all the mentions of
0056 FIXME, TODO or XXX in the source code. Ideally, all of these should be in
0057 Bugzilla, but sometimes they're not.
0058 
0059 API stability policy
0060 ====================
0061 
0062 We use an "odd/even" versioning scheme where the minor version (the y in
0063 x.y.z) determines stability - stable branches have y even, development
0064 branches have y odd.
0065 
0066 In a stable (even) branch, we will not make incompatible API or ABI changes
0067 between one release tarball and the next.
0068 
0069 In a development (odd) branch, if we make incompatible ABI changes
0070 between one release tarball and the next, we will change the SONAME of the
0071 library; we will attempt to avoid incompatible API or ABI changes.
0072 
0073 Unreleased builds straight from git identify themselves as version
0074 "x.y.z.1". We DO NOT make any API guarantees about unreleased builds:
0075 any binary relying on new functionality from an unreleased build is not
0076 guaranteed to work with any subsequent release or unreleased build, and on
0077 platforms with versioned symbols (mainly Linux) it definitely won't work with
0078 subsequent releases (you'll have to at least relink the binary).
0079 We do not increment SONAMEs on the basis of unreleased changes.
0080 
0081 Unreleased builds are compiled with -Werror, so they might stop working
0082 if your gcc version issues more warnings than ours. If this is a problem
0083 for you, use a release tarball.
0084 
0085 Contact info
0086 ============
0087 
0088 This library is maintained by the Telepathy project:
0089   <https://github.com/TelepathyIM>
0090   <https://telepathy.freedesktop.org>
0091   <mailto:telepathy@lists.freedesktop.org>
0092   <irc://irc.freenode.net/telepathy>
0093 
0094 Telepathy development was supported by Collabora Ltd.
0095   <http://www.collabora.co.uk/>.
0096 
0097 Hacking
0098 =======
0099 
0100 See HACKING for version control, coding style and patch submission information.