merge(dev): release 11.0.7

Installation/src/LinuxInstall.rst

@@ -12,26 +12,39 @@ If not already installed:
 #. Install `CMake <http://www.cmake.org/download/>`_. The minimal version required is **3.7** if you want to compile with precompiled headers (build twice faster, enabled by default). Otherwise you can use a 3.1 version.
 #. Install `Ninja <https://ninja-build.org/>`_
 
-Depending on which linux distribution you use, for example on Debian/Ubuntu/Mint you can do:
+Depending on which linux distribution you use, for example on **Debian/Ubuntu/Mint** you can run the following command to download and install these tools:
 
 .. code:: bash
 
     $ apt-get install build-essential ninja-build python2.7 git cmake
 
 .. warning::
-    If the **CMake** version of your distribution is not sufficient (Mint 17 for instance ships only the 2.18 version), you can easily grab it on the `Kitware website <https://cmake.org/download/>`_. Download the **binary** version (much easier than compiling yourself), extract it to a folder (i.e. /home/login/software/cmake/) and add the ``bin/`` folder inside it to your ``PATH`` environment variable :
+    If the **CMake** version of your distribution is not sufficient (Mint 17 for instance ships only the 2.18 version), you can easily grab it on the `Kitware website <https://cmake.org/download/>`_. Download the **binary** version (much easier than compiling yourself), extract it to a folder (i.e. /home/login/software/cmake/) and add the ``bin/`` folder inside it to your ``PATH`` environment variable:
 
     .. code:: bash
 
         # ~/.bashrc
         export PATH=/home/login/software/cmake/bin:$PATH
-    
-Qt is an external library used in FW4SPL. For the successful compilation of Qt with FW4SPL, please see the following requirements:
+
+Few basic development libraries need to be installed first: ``zlib``, ``iconv``, ``jpeg``, ``png``, ``tiff``, ``freetype``, ``libxml``, ``expat``, and ``icu``. On **Mint 18.x** for instance, you can install them using the following command : 
+
+.. code:: bash
+
+    $ sudo apt-get install libz3-dev libiconv-hook-dev libpng12-dev \
+      libjpeg-turbo8-dev libtiff5-dev libfreetype6-dev libxml2-dev \
+      libexpat1-dev libicu-dev
+
+Next, we also need to install specific development libraries for **Qt**. These requirements are detailed here:
 
 - http://wiki.qt.io/Building_Qt_5_from_Git
 
-Follow the instructions there to install the necessary packages on your system for **Build essentials**, **libxcb** and **QtMultimedia**. For the latter, please note that we use gstreamer-1.0 by default, so please replace ``libgstreamer0.10-dev`` and ``libgstreamer-plugins-base0.10-dev`` by ``libgstreamer1.0-dev`` and ``libgstreamer-plugins-base1.0-dev``. You can safely ignore instructions for QtWebKit and QtWebEngine, we don't build them.
-Since we build Qt with openssl support you also need to install ``libssl-dev`` (be sure that the version is equal or upper to 1.0.0). Last for VTK we also need the X Toolkit Intrinsics library headers, that you can easily install for instance on a Debian-based distribution with the package ``libxt-dev``.
+Follow the instructions there to install the necessary packages on your system for **Build essentials**, **libxcb** and **QtMultimedia**. For the latter, please note that we use **gstreamer-1.0** by default, so please replace ``libgstreamer0.10-dev`` and ``libgstreamer-plugins-base0.10-dev`` by ``libgstreamer1.0-dev`` and ``libgstreamer-plugins-base1.0-dev``. You can safely ignore instructions for QtWebKit and QtWebEngine, we don't build them.
+Since we build Qt with openssl support you also need to install ``libssl-dev`` (be sure that the version is equal or upper to 1.0.0).
+``libudev-dev`` and ``libusb-1.0.0-dev`` are required by the OpenNI library. Last for VTK we also need the X Toolkit Intrinsics library headers, that you can easily install for instance on a Debian-based distribution with the packages ``libxt-dev``, ``libxrandr-dev`` and ``libxaw7-dev``.
+
+If you are building the dependencies with the fw4spl-ext-deps additional dependencies, the VLC libraries are also needed, regarding to streaming capabilities, and thus the packages: ``libvlc-dev``, ``libvlccore-dev`` and ``vlc-nox``, are required.
+
+Finally, please note that we provide Dockerfile at this `link <https://github.com/fw4spl-org/docker-fw4spl-deps>`_. The commands for dependency installation are provided there.
 
 .. include:: CommonDeps.rst
 

README.md

@@ -0,0 +1,17 @@
+Description
+===========
+
+This repository contains the documentation of FW4SPL. The main repository is available [here](https://github.com/fw4spl-org/fw4spl).
+
+Building the documentation
+==========================
+
+In order to build this documentation, you will need to install Sphinx (especially the sphinx-build command).
+The documentation for installation is available [here](http://www.sphinx-doc.org/en/stable/install.html).
+
+Once sphinx is installed, launch the following command at the root of your local copy to generate html documentation:
+```
+make html
+```
+
+Other generation backends can be listed with the `make` command.

Testing/index.rst

@@ -0,0 +1,45 @@
+************
+Testing
+************
+
+.. toctree::
+    :maxdepth: 2
+
+
+
+.. _CTest: http://cmake.org/
+.. _CMake: http://cmake.org/
+.. _CppUnit: https://sourceforge.net/projects/cppunit
+.. _fw4spl: https://github.com/fw4spl-org/fw4spl
+
+fw4spl_ uses CTest_ and CppUnit_ for unit testing.
+
+Building
+--------
+
+When building fw4spl_ with CMake_, you will need to enable the ``BUILD_TESTS`` option, e.g. with the ``-DBUILD_TESTS=ON`` command line option.
+
+Launching unit tests
+--------------------
+
+In you build directory, you can launch the unit tests with the ``ctest`` command in the following way:
+
+.. code-block:: shell
+
+    # Launch the tests sequentially
+    ctest .
+
+    # Launch the tests using 4 jobs, similar to the -j option of make
+    ctest -j 4 .
+
+    # You can also use the make or ninja commands to do so
+    make test
+
+    ninja test
+
+Additional data
+---------------
+
+Additional data need to be download to run all the unit tests. They are available at the following link.
+You can then specify the directory, where the data are located, with the ``FWTEST_DATA_DIR`` environment variable.
+

index.rst

@@ -8,6 +8,7 @@ FW4SPL documentation
    Introduction/index
    Installation/index
    SAD/index
+   Testing/index
    CodingStyle/index
    Doxygen <http://fw4spl-org.github.io/fw4spl-dox/>
    FAQ/FAQ-FW4SPL