Prepare 0.21.5

[profile/ivi/rygel.git] / README

diff --git a/README b/README
index 052ddca..1189874 100644 (file)
--- a/README
+++ b/README
@@ -1,8 +1,12 @@
 What is Rygel?
 =============
 
-Rygel is a collection of DLNA (UPnP AV) devices, implemented through a plug-in
-mechanism.
+Rygel is a home media solution that allows you to easily share audio, video and
+pictures, and control of media player on your home network. In technical terms
+it is both a UPnP AV MediaServer and MediaRenderer implemented through a plug-in
+mechanism. Interoperability with other devices in the market is achieved by
+conformance to very strict requirements of DLNA and on the fly conversion of
+media to format that client devices are capable of handling.
 
 Important facts and features
 ============================
@@ -12,8 +16,7 @@ Important facts and features
     release.
   * Based on GUPnP.
   * Written entirely in Vala language.
-  * APIs to ease the implementation of AV devices (currently only MediaServer
-    version 2.0 specification.
+  * APIs to ease the implementation of AV devices.
   * Export of on-disk media:
     * Tracker plugin.
     * MediaExport plugin: Recursively exports folders and files specified in
@@ -23,14 +26,19 @@ Important facts and features
   * Export of media hierarchies provided by external applications through
     implementation of D-Bus MediaServer spec. Applications that utilize
     this feature are:
-    * PulseAudio: Provides streams for input/output devices on the system.
-    * DVB Daemon: Provides live TV (DVB) channel streams.
+    * DVB Daemon
+    * Rhythmbox
   * Export of GStreamer pipelines as media items on the network, specified
     through gst-launch syntax in the user configuration.
   * Audio and Video Transcoding: source format could be anything GStreamer's
     decodebin2 can handle but output formats are currently limited to: mp3, PCM
     and MPEG TS. Fortunately the transcoding framework is flexible enough to
     easily add more transcoding targets.
+  * Standalone MediaRenderer plugin based on GStreamer playbin2 element.
+  * Export of media players that implement MPRIS2 D-Bus interface, as
+    MediaRenderer devices. Known implementing applications are:
+    * Rhythmbox
+    * VLC
 
 Requirements
 ============
@@ -46,7 +54,6 @@ Requirements
       * libuuid
       * libsoup
       * vala (not if building from release tarballs)
-      * gupnp-vala (not if building from release tarballs)
     * Preferences UI:
       * gtk+
     * MediaExport:
@@ -54,11 +61,16 @@ Requirements
   * Run-time:
     * Definitely needed:
       * gst-plugins-base
+      * shared-mime-info
     * Might be needed (depending on your usage and media collection):
       * gst-plugins-good
       * gst-ffmpeg
       * gst-plugins-bad
       * gst-plugins-ugly
+      
+To build without gstreamer, use:
+  --with-media-engine=simple
+This will also disable any plugins that use gstreamer.
 
 References
 ==========
@@ -74,6 +86,6 @@ References
   * http://www.gnome.org/projects/tracker
   * http://live.gnome.org/DVBDaemon
   * http://www.zdf.de
-  * http://live.gnome.org/Rygel/MediaServerSpec
-  * http://www.pulseaudio.org
+  * http://live.gnome.org/Rygel/MediaServer2Spec
+  * http://www.mpris.org/2.0/spec/