docs(installation): update deps ENABLE_* options

fw4spl-org · Jun 7, 2018 · 89a2257 · 89a2257
1 parent 87af4f9
commit 89a2257
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 38 deletions.
diff --git a/Installation/src/CommonDeps.rst b/Installation/src/CommonDeps.rst
@@ -128,27 +128,16 @@ Click on "configure".
 Dependencies generation
 +++++++++++++++++++++++
 
-.. warning::
-
-    ``ENABLE_PCL``, ``ENABLE_LIBSGM`` and ``ENABLE_OPENCV_CUDA`` require the `Cuda <https://developer.nvidia.com/cuda-downloads>`_ library, if you intend to use one of these, you should install it before.
-
-Set the following options (some of the options will be needed for the optional source):
+Set the following options (some of the options will be needed for the optional source repositories):
 
-    * ``ENABLE_EXPERIMENTAL_DEPS``: set to ON to build experimentals libraries (You shouldn't use it).
-    * ``ENABLE_INFINITAM``: set to ON to build infinitam.
-    * ``ENABLE_LIBSGM``: set to ON to build libSGM dependencies.
-    * ``ENABLE_ODIL``: set to ON to build Odil dependencies.
-    * ``ENABLE_OGRE``: set to ON to build ogre.
-    * ``ENABLE_OPENCV_CONTRIB``: set to ON to build OpenCV contrib extra modules.
-    * ``ENABLE_OPENCV_CUDA``: set to ON to build OpenCV with CUDA support.
-    * ``ENABLE_OPEN_MP``: set to ON to enable OpenMP.
-    * ``ENABLE_BUILD_ORB_SLAM2``: set to ON to build ORB Slam 2.
-    * ``ENABLE_PCL``: set to ON to build PCL.
-    * ``ENABLE_PCL_CUDA``: set to ON to build PCL with CUDA support.
-    * ``ENABLE_REALSENSE``: set to ON to build librealsense.
-    * ``ENABLE_SOFA``: set to ON to build sofa.
+    * ``ENABLE_AR``: Build **fw4spl-ar** dependencies (OpenCV, PCL, OpenIGTLink...).
+    * ``ENABLE_OGRE``: Build Ogre3D and its dependencies (necessary for **fw4spl-ogre**).
+    * ``ENABLE_CUDA``: Enable CUDA support in some libraries (OpenCV, PCL, libSGM). This requires `Cuda <https://developer.nvidia.com/cuda-downloads>`_ library to be installed on the system.
+    * ``ENABLE_SOFA``: Build sofa.
+    * ``ENABLE_EXTRAS`` : Build dependencies that are not used currently in the open-source repositories (Odil, Bullet, realsense, libSGM,...).
+    * ``ENABLE_EXPERIMENTAL_DEPS``: Build experimental libraries (you shouldn't use it, moreover this option is only available with **fw4spl-ext-deps**).
 
 Generate the code by pressing *"g"* on NCurses based editor or click on "generate" on gui.
 
 .. warning::
-    Do not compile debug and release with the same Build and Install folders. If you followed the recommended folder layout, this should be fine.
+    Do not compile debug and release with the same Build and Install folders. If you followed the recommended folder layout, this should be fine.
diff --git a/Installation/src/WindowsInstall.rst b/Installation/src/WindowsInstall.rst
@@ -138,25 +138,14 @@ Dependencies configuration
 Dependencies generation
 +++++++++++++++++++++++
 
-.. warning::
-
-    ``ENABLE_PCL``, ``ENABLE_LIBSGM`` and ``ENABLE_OPENCV_CUDA`` require `Cuda <https://developer.nvidia.com/cuda-downloads>`_ library, if you intend to use one of these, you should install it befor and re-open the ‘VS2015 x64 Native Tools Command Prompt’ to update your PATH.
-
-Set the following options (some of the options will be needed for the optional source):
-
-    * ``ENABLE_EXPERIMENTAL_DEPS``: set to ON to build experimentals libraries (You shouldn't use it).
-    * ``ENABLE_INFINITAM``: set to ON to build infinitam.
-    * ``ENABLE_LIBSGM``: set to ON to build libSGM dependencies.
-    * ``ENABLE_ODIL``: set to ON to build Odil dependencies.
-    * ``ENABLE_OGRE``: set to ON to build ogre.
-    * ``ENABLE_OPENCV_CONTRIB``: set to ON to build OpenCV contrib extra modules.
-    * ``ENABLE_OPENCV_CUDA``: set to ON to build OpenCV with CUDA support.
-    * ``ENABLE_OPEN_MP``: set to ON to enable OpenMP.
-    * ``ENABLE_BUILD_ORB_SLAM2``: set to ON to build ORB Slam 2.
-    * ``ENABLE_PCL``: set to ON to build PCL.
-    * ``ENABLE_PCL_CUDA``: set to ON to build PCL with CUDA support.
-    * ``ENABLE_REALSENSE``: set to ON to build librealsense.
-    * ``ENABLE_SOFA``: set to ON to build sofa.
+Set the following options (some of the options will be needed for the optional source repositories):
+
+    * ``ENABLE_AR``: Build **fw4spl-ar** dependencies (OpenCV, PCL, OpenIGTLink...).
+    * ``ENABLE_OGRE``: Build Ogre3D and its dependencies (necessary for **fw4spl-ogre**).
+    * ``ENABLE_CUDA``: Enable CUDA support in some libraries (OpenCV, PCL, libSGM). This requires `Cuda <https://developer.nvidia.com/cuda-downloads>`_ library to be installed on the system and present in your PATH.
+    * ``ENABLE_SOFA``: Build sofa.
+    * ``ENABLE_EXTRAS`` : Build dependencies that are not used currently in the open-source repositories (Odil, Bullet, realsense, libSGM,...).
+    * ``ENABLE_EXPERIMENTAL_DEPS``: Build experimental libraries (you shouldn't use it, moreover this option is only available with **fw4spl-ext-deps**).
 
 * click on "generate".