[telepathy-mission-control/master] Write a NEWS file and a README (both loosely based on telepathy-glib's)

Simon McVittie simon.mcvittie at collabora.co.uk
Fri Jun 5 09:00:35 PDT 2009


---
 NEWS   |   52 ++++++++++++++++++++++++++
 README |  125 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 177 insertions(+), 0 deletions(-)

diff --git a/NEWS b/NEWS
index e69de29..973e2fa 100644
--- a/NEWS
+++ b/NEWS
@@ -0,0 +1,52 @@
+telepathy-mission-control 5.1.0 (UNRELEASED)
+============================================
+
+The "beta 75 would have been silly" release.
+
+After months of development, this is the first numbered release of Mission
+Control 5. We jumped straight to 5.1 in order to use the Linux-style odd/even
+versioning seen in the other Telepathy components, so the 5.1.x development
+branch will lead to the 5.2.x stable branch.
+
+Changes since Mission Control 4 are too numerous to list here, but here are
+the major architectural changes.
+
+The proprietary MissionControl API no longer exists; the daemon is a
+telepathy-spec-compliant AccountManager, and also a telepathy-spec-compliant
+ChannelDispatcher. Consequences of this include:
+
+* Clients are no longer expected to implement the ChannelHandler interface.
+  Instead, they may implement the Observer, Approver and/or Handler interfaces
+  specified in telepathy-spec.
+
+* The design of channel dispatching copes better with having multiple user
+  interface components installed.
+
+* Accounts' presence, avatar and nickname are now independent (stored
+  per-account), allowing for more precise control by UIs.
+
+* Accounts no longer have to belong to a "profile", although they still can
+  (albeit only by using a non-standard extension).
+
+Accounts are now stored in a flat file, rather than by abusing GConf. The
+included mc-account-convert tool might be able to convert MC 4 accounts to
+the MC 5 format, if you're lucky.
+
+libmissioncontrol-server has changed its API and ABI considerably, and is not
+yet considered stable in its new form either. It is no longer installed by
+default (in a normal configuration it'll just be compiled into the daemon).
+
+libmissioncontrol (based on libtelepathy and also known as
+libmissioncontrol-client) no longer exists, and has been replaced by
+libmcclient (based on telepathy-glib).
+
+Mission Control 5 is not a drop-in replacement for Mission Control 4, and
+cannot be used by Mission-Control-4-based applications like Empathy 2.26
+and the Maemo 4 platform. However, both versions can be installed
+independently in the same directory prefix, to facilitate porting from one to
+the other.
+
+Known regressions since Mission Control 4:
+
+* There is no gnome-keyring integration yet.
+* The client and server library APIs are not considered to be stable yet.
diff --git a/README b/README
index e69de29..7df10bb 100644
--- a/README
+++ b/README
@@ -0,0 +1,125 @@
+===========================
+telepathy-mission-control 5
+===========================
+
+Telepathy Mission Control 5 is an account manager and channel dispatcher for
+the Telepathy framework, allowing user interfaces and other clients
+to share connections to real-time communication services without conflicting.
+It implements the AccountManager and ChannelDispatcher D-Bus APIs as described
+by telepathy-spec.
+
+The account manager part stores real time communication account details,
+connects to the stored accounts on request, and sets the accounts' presence,
+nickname and avatar according to requests from Telepathy user interfaces and
+other components.
+
+The channel dispatcher part responds to incoming communication channels
+(message streams, voice/video calls, file transfers etc.) by dispatching
+them to suitable user interfaces, and requests outgoing communication
+channels according to requests from a Telepathy UI.
+
+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.
+
+Mission Control currently also provides a C API. Please note that this API is
+subject to rapid change (see below).
+
+Requirements
+============
+
+Building Mission Control requires:
+  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/>
+  telepathy-glib <http://telepathy.freedesktop.org/releases/telepathy-glib/>
+
+  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 can also make use of:
+  gtkdoc <http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/>
+
+See configure.ac for full details, including versions required.
+Of the packages listed above, only GLib, GObject, libdbus, dbus-glib and
+telepathy-glib are required at runtime.
+
+Building from git 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-mission-control>
+
+D-Bus API stability
+===================
+
+Interfaces described as stable in the Telepathy Specification
+<http://telepathy.freedesktop.org/spec/> are considered stable and will not
+generally have incompatible changes.
+
+All other interfaces (including draft interfaces and Nokia-specific
+extensions) are subject to change.
+
+C API stability
+===============
+
+libmcclient is a client library for communicating with Mission Control. It
+is not necessarily suitable for communication with any other Telepathy
+AccountManager or ChannelDispatcher implementations, and will probably be
+phased out eventually, in favour of library support in telepathy-glib.
+
+libmissioncontrol-server contains most of the implementation of MC, and can
+be used to produce a derivative of MC containing desktop- or device-specific
+behaviour, like Maemo's proprietary osso-mission-control package. It is only
+built and installed as a library if Mission Control is configured with
+the --enable-plugins option; this is not recommended on mainstream Linux
+distributions.
+
+At this stage in development, neither library is considered stable; only
+depend on them if you have control over the specific version of MC you're
+using.
+
+Versioning
+==========
+
+Starting from version 5.1.0, Mission Control follows the same Linux-style
+odd/even minor versioning policy as most other Telepathy components: the 5.1.x
+series are development releases, and 5.2.x will be the first stable branch.
+
+Intermediate versions built from the git repository have a "+" suffix on the
+version number, so version "5.1.0+" could be any snapshot taken between 5.1.0
+and 5.1.1.
+
+Contact info
+============
+
+Mission Control was originally written by Nokia Corporation for the Maemo
+platform, but it is now maintained by the Telepathy project:
+  <http://telepathy.freedesktop.org/>
+  <mailto:telepathy at lists.freedesktop.org>
+  <irc://irc.freenode.net/telepathy>
+
+Hacking
+=======
+
+The current development version of MC is available from the
+'master' branch in the git repository:
+  <git://git.collabora.co.uk/git/telepathy-mission-control.git>
+  <git+ssh://git.collabora.co.uk/git/telepathy-mission-control.git>
+  <http://git.collabora.co.uk/?p=telepathy-mission-control.git> (gitweb)
+
+Stable branches will be made available from branches with names like
+'telepathy-mission-control-5.2' in the same repository.
+
+Contributions for review should be attached to bugs in freedesktop.org
+Bugzilla, with the "patch" tag. If there's no relevant bug, open one:
+  <https://bugs.freedesktop.org/enter_bug.cgi?product=Telepathy&component=telepathy-mission-control>
+
+MC does not yet follow <http://telepathy.freedesktop.org/wiki/Style>. Please
+follow the style used in the current code.
-- 
1.5.6.5




More information about the telepathy-commits mailing list