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.
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, QtDBus, QtNetwork and QtXml (QtGui and QtWidgets are required for some examples) <http://www.qt-project.org/>
0027 
0028   GNU make <http://www.gnu.org/software/make/>
0029   pkg-config <http://ftp.gnome.org/pub/GNOME/sources/pkg-config/>
0030   libxslt, xsltproc <http://xmlsoft.org/XSLT/>
0031   Python <http://www.python.org/>
0032 
0033 For the full set of regression tests to run, you'll also need:
0034   telepathy-glib <http://telepathy.freedesktop.org/releases/telepathy-glib/>
0035 
0036 For building the Farsight convenience library, you'll need:
0037   telepathy-glib <http://telepathy.freedesktop.org/releases/telepathy-glib/>
0038   telepathy-farsight <http://telepathy.freedesktop.org/releases/telepathy-farsight/>
0039   GStreamer <http://gstreamer.freedesktop.org/>
0040 
0041 and to build the Farstream convenience library, you'll need:
0042   telepathy-glib <http://telepathy.freedesktop.org/releases/telepathy-glib/>
0043   telepathy-farstream <http://telepathy.freedesktop.org/releases/telepathy-farstream/>
0044   farstream <http://freedesktop.org/software/farstream/releases/>
0045   GStreamer <http://gstreamer.freedesktop.org/>
0046 
0047 See CMakeLists.txt for full details, including versions required.
0048 Of the packages listed above, only Qt libraries are required at runtime.
0049 
0050 Building also requires the cmake build system.
0051 
0052 Qt 5 alpha release contains some build issues that should be addressed in order to build
0053 telepathy-qt against it:
0054 
0055   - When running 'configure' in Qt 5 alpha, the pkg-config files are properly generated, but when
0056     'make' is executed, these files are replaced with empty ones. So, to build telepathy-qt against
0057     it one must either backup the pkg-config files generated during the 'configure' phase before
0058     running 'make' and replace them afterwards, or re-run 'configure' with the same parameters
0059     after building it.
0060 
0061   - If Qt 5 alpha is built with -reduce-relocations enabled, one must add the keyword
0062     "reduce_relocations" to qtbase/lib/pkgconfig/QtCore.pc in the qt_config section, so that
0063     telepathy-qt knows when to use -fPIC/PIE at linking stage accordingly.
0064 
0065 Both issues were reported and should be fixed when beta is out.
0066 
0067 Bugs, feature requests and to-do list
0068 =====================================
0069 
0070 Report all bugs, feature requests and "to-do" items here:
0071   <https://bugs.freedesktop.org/enter_bug.cgi?product=Telepathy&component=tp-qt>
0072 
0073 Running "make check" will produce FIXME.out, which lists all the mentions of
0074 FIXME, TODO or XXX in the source code. Ideally, all of these should be in
0075 Bugzilla, but sometimes they're not.
0076 
0077 API stability policy
0078 ====================
0079 
0080 We use an "odd/even" versioning scheme where the minor version (the y in
0081 x.y.z) determines stability - stable branches have y even, development
0082 branches have y odd.
0083 
0084 In a stable (even) branch, we will not make incompatible API or ABI changes
0085 between one release tarball and the next.
0086 
0087 In a development (odd) branch, if we make incompatible ABI changes
0088 between one release tarball and the next, we will change the SONAME of the
0089 library; we will attempt to avoid incompatible API or ABI changes.
0090 
0091 Unreleased builds straight from git identify themselves as version
0092 "x.y.z.1". We DO NOT make any API guarantees about unreleased builds:
0093 any binary relying on new functionality from an unreleased build is not
0094 guaranteed to work with any subsequent release or unreleased build, and on
0095 platforms with versioned symbols (mainly Linux) it definitely won't work with
0096 subsequent releases (you'll have to at least relink the binary).
0097 We do not increment SONAMEs on the basis of unreleased changes.
0098 
0099 Unreleased builds are compiled with -Werror, so they might stop working
0100 if your gcc version issues more warnings than ours. If this is a problem
0101 for you, use a release tarball.
0102 
0103 Contact info
0104 ============
0105 
0106 This library is maintained by the Telepathy project:
0107   <http://telepathy.freedesktop.org/>
0108   <mailto:telepathy@lists.freedesktop.org>
0109   <irc://irc.freenode.net/telepathy>
0110 
0111 Telepathy development is supported by Collabora Ltd.
0112   <http://www.collabora.co.uk/>.
0113 
0114 Hacking
0115 =======
0116 
0117 See HACKING for version control, coding style and patch submission information.