From 66c13fd2e03973735f6098317ba66db5840b1973 Mon Sep 17 00:00:00 2001 From: Victor Poughon <victor.poughon@cnes.fr> Date: Tue, 11 Oct 2016 10:19:25 +0200 Subject: [PATCH] DOC: Minor Cookbook updates for release 5.8 --- Documentation/Cookbook/rst/Installation.rst | 4 ++-- Documentation/Cookbook/rst/Installation_Linux.txt | 4 +++- Documentation/Cookbook/rst/Installation_Windows.txt | 13 +++++-------- Documentation/Cookbook/rst/index.rst | 10 +++++++--- 4 files changed, 17 insertions(+), 14 deletions(-) diff --git a/Documentation/Cookbook/rst/Installation.rst b/Documentation/Cookbook/rst/Installation.rst index e747ac0a01..973783f633 100644 --- a/Documentation/Cookbook/rst/Installation.rst +++ b/Documentation/Cookbook/rst/Installation.rst @@ -24,7 +24,7 @@ Windows .. include:: Installation_Windows.txt Linux x86_64 ------------ +------------ .. include:: Installation_Linux.txt @@ -33,7 +33,7 @@ MacOS X ------- .. include:: Installation_Macx.txt - + Other packages -------------- diff --git a/Documentation/Cookbook/rst/Installation_Linux.txt b/Documentation/Cookbook/rst/Installation_Linux.txt index f686070355..f86681bd63 100644 --- a/Documentation/Cookbook/rst/Installation_Linux.txt +++ b/Documentation/Cookbook/rst/Installation_Linux.txt @@ -1,5 +1,7 @@ -We provide binary package for GNU/Linux x86_64. This package include +We provide a binary package for GNU/Linux x86_64. This package includes all of OTB applications along with commandline and graphical launchers. +Download it from `OTB's download page +<https://www.orfeo-toolbox.org/download>`__. This package is a self-extractible archive. You may uncompress it with a double-click on the file, or with the command line : diff --git a/Documentation/Cookbook/rst/Installation_Windows.txt b/Documentation/Cookbook/rst/Installation_Windows.txt index 9d8edbc443..164a75b241 100644 --- a/Documentation/Cookbook/rst/Installation_Windows.txt +++ b/Documentation/Cookbook/rst/Installation_Windows.txt @@ -1,12 +1,9 @@ - -We provide for Windows Seven and later through standalone packages. They -are cross-compiled with MinGW, for 32 bits and 64 bits platforms. They -contain all applications and their launchers (both command line and graphical -launchers are provided). -Check the `Download page <https://www.orfeo-toolbox.org/download>`__ +We provide standalone packages for Windows 7 and later. Download it from the +`here <https://www.orfeo-toolbox.org/download>`__, and pick the correct version +(32 bit or 64 bit) depending on your system. -There is a 32 bits and a 64 bits version. They contain the same directory -structure: +Extract the archive and use one of the launchers, they contain all applications +and their launchers (both command line and graphical launchers are provided): - ``monteverdi.bat`` : A launcher script for Monteverdi diff --git a/Documentation/Cookbook/rst/index.rst b/Documentation/Cookbook/rst/index.rst index 92906b7503..a6dd916603 100644 --- a/Documentation/Cookbook/rst/index.rst +++ b/Documentation/Cookbook/rst/index.rst @@ -28,8 +28,15 @@ how to start using Monteverdi and OTB applications to view and process your data, and recipes on how to accomplish typical remote sensing tasks. Finally, there is also documentation on every application shipped with OTB. +Get started now with the :doc:`Installation` chapter. + +Get help, share your experience and contribute to the Orfeo-Toolbox project by +joining `our community <https://www.orfeo-toolbox.org/community/>`_ and +`users mailing list <https://groups.google.com/forum/?hl=fr#!forum/otb-users/join>`_. + For other documentation, be sure to read: +- OTB's website: `www.orfeo-toolbox.org <https://www.orfeo-toolbox.org/>`_ - `OTB Software Guide <http://orfeo-toolbox.org/SoftwareGuide/>`_ for advanced users and developers. The software guide contains documented code examples, descriptions of the ITK pipeline model, multithreading and @@ -37,6 +44,3 @@ For other documentation, be sure to read: - `Doxygen <http://orfeo-toolbox.org/doxygen/>`_, for exhaustive documentation of the C++ API. -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` -- GitLab