docs: Mention Qt5 support in the documentation and bring the README up-to-date

2 files changed, 41 insertions, 16 deletions

diff --git a/README b/README
index fafc4d6..1805065 100644
--- a/README
+++ b/README
@@ -18,7 +18,7 @@ In addition, it provides a "qwidgetvideosink" GStreamer element, an video
 sink element that can draw directly on QWidgets using QPainter.
 
 [1]. http://gstreamer.freedesktop.org/
-[2]. http://qt.nokia.com/
+[2]. http://qt-project.org/
 
 2. Building
 -----------
@@ -27,12 +27,12 @@ sink element that can draw directly on QWidgets using QPainter.
 ----------------
 
 QtGStreamer requires the following software to be installed in order to build:
- * CMake 2.8 or later <http://www.cmake.org/>
- * GStreamer 0.10.33 or later <http://gstreamer.freedesktop.org/>
+ * CMake 2.8.9 or later <http://www.cmake.org/>
+ * GStreamer 0.10.36 or later from the 0.10 series <http://gstreamer.freedesktop.org/>
    With its dependencies:
    - Glib / GObject <http://www.gtk.org/>
-   and including gstreamer-plugins-base (0.10.33 or later)
- * Qt 4.7 or later <http://qt.nokia.com/>
+   and including gstreamer-plugins-base (0.10.36 or later)
+ * Qt4 or Qt5 (4.7 or later / 5.0 or later) <http://qt-project.org/>
  * Boost 1.39 or later <http://www.boost.org/>
  * Flex (only if QTGSTREAMER_CODEGEN=ON, see below) <http://flex.sourceforge.net/>
  * Bison (only if QTGSTREAMER_CODEGEN=ON, see below) <http://www.gnu.org/software/bison/>
@@ -77,6 +77,10 @@ Other options that can be passed to cmake include:
   Allows you to specify the type of the build. This is a standard
   cmake option, see the cmake man page for details.
 
+* -DQT_VERSION=[4|5]
+  Allows you to specify the Qt version that you want to build against.
+  The default is 4.
+
 * -DQTGSTREAMER_STATIC=[ON|OFF]
   Allows you to choose whether to build static or dynamic libraries.
   ON means static, OFF means dynamic.
@@ -115,9 +119,6 @@ Other options that can be passed to cmake include:
   Allows you to specify the url that gst-inspect will show as the "Origin URL"
   for all the element plugins that are build from this source package.
 
-* -DLIB_SUFFIX=64
-  Set this to install in $prefix/lib64 instead of $prefix/lib.
-
 2.4 Generating documentation
 ----------------------------
 
@@ -144,7 +145,7 @@ Web:
     http://gstreamer.freedesktop.org/wiki/QtGStreamer
 
 Mailing list:
-    mailto:gstreamer-devel@lists.sourceforge.net
+    mailto:gstreamer-devel@lists.freedesktop.org
 
 Irc channels:
     irc://irc.freenode.net/gstreamer
@@ -157,5 +158,5 @@ Bugs, feature requests & patches should be sent at:
     https://bugzilla.gnome.org/enter_bug.cgi?product=GStreamer&component=qt-gstreamer
 
 --
-George Kiagiadakis <george.kiagiadakis@collabora.co.uk>
-Last updated: Feb 7, 2012
+George Kiagiadakis <george.kiagiadakis@collabora.com>
+Last updated: Jun 9, 2013
diff --git a/src/main.dox b/src/main.dox
index 6357668..0d6a1b4 100644
--- a/src/main.dox
+++ b/src/main.dox
@@ -33,7 +33,7 @@
  * \li QtGStreamerUtils - Library providing some high level utility classes.
  *
  * In addition, it provides GStreamer elements for drawing video on widgets,
- * graphics items and QML items.
+ * graphics items and QtQuick items.
  *
  * \section api_reference API Reference
  * \li <a href="classes.html">All Classes</a>
@@ -55,7 +55,9 @@
  * You can just do:
  *
  * \code
- * find_package(QtGStreamer)
+ * find_package(QtGStreamer) # for Qt4 QtGStreamer
+ * # ..... OR .....
+ * find_package(Qt5GStreamer) # for Qt5 QtGStreamer
  * \endcode
  *
  * which will find QtGStreamer and define the following variables:
@@ -93,6 +95,13 @@
  * \li QtGStreamerUi-0.10 - the libraries needed to use QtGStreamerUi
  * \li QtGStreamerUtils-0.10 - the libraries needed to use QtGStreamerUtils
  *
+ * When QtGStreamer is built using Qt5, those packages are called differently:
+ *
+ * \li Qt5GLib-2.0
+ * \li Qt5GStreamer-0.10
+ * \li Qt5GStreamerUi-0.10
+ * \li Qt5GStreamerUtils-0.10
+ *
  * \section other_build_systems Other build systems
  *
  * If you are not using one of the above build systems, you could also use QtGStreamer
@@ -149,9 +158,9 @@
  * from Qt that they must be created, destroyed and have their signals and
  * properties handled from the main (GUI) thread.
  *
- * When drawing video on QML or QGraphicsView, it is recommended to use
+ * When drawing video on QtQuick1 (QML) or QGraphicsView, it is recommended to use
  * qtglvideosink, if possible, and fall back to qtvideosink otherwise.
- *  When drawing on QWidgets, it is recommended to embed the platform's
+ * When drawing on QWidgets, it is recommended to embed the platform's
  * hardware accelerated sink, such as xvimagesink on X11, and if this is
  * not possible, use qwidgetvideosink.
  *
@@ -194,8 +203,23 @@
  * QGst::Ui::GraphicsVideoWidget with QGst::Ui::GraphicsVideoSurface to paint
  * on a QGraphicsView.
  *
- * If you are using QML, there is also a "VideoItem" element available when you import
+ * If you are using QtQuick1, there is also a "VideoItem" element available when you import
  * "QtGStreamer 0.10". See the qmlplayer example for details.
+ *
+ * \section qt5_support Qt5 support
+ *
+ * When QtGStreamer is compiled with Qt5, those 3 elements are named:
+ *
+ * \li qt5videosink
+ * \li qt5glvideosink
+ * \li qwidget5videosink
+ *
+ * This is done to allow them to be parallel installable to their Qt4 counterparts
+ * and to avoid Qt version mixing through gstreamer's plugin loading.
+ *
+ * All 3 elements are based on Qt4 concepts (QtWidgets, QtQuick1) and do not support
+ * Qt5's new QtQuick2 scene-graph architecture. Support for that may be added in
+ * a future version of QtGStreamer.
  */
 
 /*! \namespace QGlib