small changes in installation procedure

manual/first-run.rst

@@ -16,7 +16,7 @@ Document Sections
 Launch Blender-VR
 -----------------
 
-Start by `running Blender-VR <installation/installation.html#running>`_. Although in the future you can launch it via a shortcut, for the first run it's better to do it via command-line, to catch any unexpected error.
+Start by opening the blenderVR GUI (see `running Blender-VR <installation/installation.html#running>`_). Although in the future you can launch it via a shortcut, for the first run it's better to do it via command-line, to catch any unexpected error.
 
 Open the Simulation File
 ------------------------

manual/installation/development.rst

@@ -1,85 +1,51 @@
 =======================================
-Install for Future BlenderVR Developers
+Install for Future blenderVR Developers
 =======================================
 
-This guide walks you over the basic steps of setting up a development environment for BlenderVR.
+This guide walks you over the basic steps of setting up a development environment for blenderVR.
 
 .. note ::
-  For casual BlenderVR users, please refer to the `Install BlenderVR <installation.html>`_ page.
+  For casual blenderVR users, please refer to the `Install blenderVR <installation.html>`_ page.
+
+The install is the same than described in `Install blenderVR <installation.html>`_ but for:
+
+* git clone of the blenderVR repository, to freely modify and eventually commit your modifications.
+* svn/git clone of the blenderVR samples, to eventually add your own demo scenes to the blenderVR samples repository
+* manual compilation of Blender, if you need to modify its source code.
 
 Most of the time you won't need to modify and rebuild Blender, so those instructions are specified separately.
 
 Document Sections
 -----------------
-* `Folder Structure`_
-* `Requirements`_
-* `Quick Setup`_
-* `Getting Samples`_
 * `Acquiring Blender`_
+* `Acquiring BlenderVR and Basic sample scenes`_
+* `Requirements`_
+* `Quick Setup and Running`_
 
-Folder Structure
------------------
-``//blender-vr/``
-*Blender-VR Source Code*
-
-``//blender/``
-*Blender Binaries*
-
-``//samples/``
-*Blender-VR Samples*
-
-``//venv/``
-*Python Virtual Environment*
-
-
-Requirements
-------------
-.. _requirements:
-
-Install those packages or make sure you have them in your system.
-
-All Time Mandatory
-******************
-
-* `GIT <http://git-scm.com/>`_
-* `Python <http://www.python.org/>`_
-
-
-Required for Interface Development
-**********************************
 
-*At this moment those packages are always required, but the plans are to make them optional.*
+Acquiring Blender
+-----------------
 
-* `PIP <https://pip.pypa.io/en/latest/installing.html>`_
-* `QT 4.8 <http://download.qt.io/archive/qt/4.8/4.8.6/>`_
+Blender-VR requires a vanilla Blender 2.74 or newer.
 
+If you ever need to modify and rebuild Blender for further customizations, please consult the `Blender's official documentation <http://wiki.blender.org/index.php/Dev:Doc/Building_Blender>`_.
 
-Required for Blender development
-********************************
+Else, download the sources provided in `Acquiring Blender <installation.html#acquiring-blender>`_.
 
-*Many packages, listed separately.*
 
-Quick Setup
------------
+Acquiring BlenderVR and Basic sample scenes
+-------------------------------------------
 
-Type the following commands in your terminal. If you are developing in Windows we recommend you to use Power Shell or similar.
+To download the latest blenderVR git version (master HEAD):
 
 .. code-block:: bash
 
-  $ cd $INSTALL_DIR
-  $ pip3 install virtualenv
-  $ pyvenv venv
-  $ source venv/bin/activate
   $ git clone https://github.com/BlenderVR/blender-vr.git
-  $ pip3 install -r blender-vr/requirements.txt
-  $ pyside_postinstall.py -install
-  $ deactivate
 
+If you do not intend to modify blenderVR source code, simply download the `Blender-VR Sources <https://github.com/BlenderVR/blender-vr/archive/v1.0.zip>`_ zipfile.
 
-Getting Samples
----------------
 
-Git is not a good system to work on binary files, so it's recommended to use the SVN protocol to interact with this repository instead.
+Regarding blenderVR samples, Git is not a good system to work on binary files, so it's recommended to use the SVN protocol to interact with the samples repository instead:
 
 .. code-block:: bash
 
@@ -100,10 +66,28 @@ Alternatively if you want to access the repository via GIT you can do::
   $ git clone https://github.com/BlenderVR/samples.git
 
 
-Acquiring Blender
------------------
+Requirements
+------------
+.. _requirements:
 
-Blender-VR requires a vanilla Blender 2.74 or newer.
-If you ever need to modify and rebuild Blender for further customizations, please consult the `Blender's official documentation <http://wiki.blender.org/index.php/Dev:Doc/Building_Blender>`_.
+Install those packages or make sure you have them in your system.
+
+All Time Mandatory
+******************
+
+* `GIT <http://git-scm.com/>`_
+* `Python <http://www.python.org/>`_
+
+
+Required for Interface Development
+**********************************
+
+*At this moment the following packages are always required, but the plans are to make them optional.*
+
+* `PIP <https://pip.pypa.io/en/latest/installing.html>`_
+* `QT 4.8 <http://download.qt.io/archive/qt/4.8/4.8.6/>`_
+
+Quick Setup and Running
+-----------------------
 
-To download the Blender required to your platform check the `User Installation <installation.html#acquiring-blender>`_ guide.
+see `Quick Setup and Running <installation.html#quick-setup>`_ in the Install blenderVR Section.

manual/installation/installation.rst

@@ -22,7 +22,7 @@ Document Sections
 Folder Structure
 ----------------
 
-After all the downloads and installations you should end up with the following folder structure. This is a recommendation, and it will be used as reference along this manual.
+After all the downloads and installations you should end up with the following folder structure. This is a recommendation, and it will be used as reference along this manual (the directory holding these files is  referred as $INSTALL_DIR in the next sections).
 
 ``//blender-vr/``
 *Blender-VR Source Code*
@@ -55,11 +55,9 @@ Optionally you can use  a patched version of Blender 2.73a available here for al
 Acquiring BlenderVR and Basic sample scenes
 -------------------------------------------
 
-* `Blender-VR Sources <https://github.com/BlenderVR/blender-vr/archive/v1.0.zip>`_ (download and unzip in the top folder, rename it to **blender-vr**)
+* `Blender-VR Sources <https://github.com/BlenderVR/blender-vr/archive/v1.0.zip>`_ (download and unzip in the top folder, rename it **blender-vr**)
 
-Before getting started is recommended to look at the available samples.
-The basic sample should help testing if everything was installed correctly, as well as testing the configuration file of your VR lab.
-The other samples are to be used as reference to develop other VR projects.
+Before getting started, you'll probably want to take a look at the available blenderVR ".blend" sample scenes.
 
 * Download `All Samples <https://github.com/BlenderVR/samples/archive/master.zip>`_
 
@@ -86,11 +84,7 @@ All Time Mandatory
 
 * `Python <http://www.python.org/>`_
 
-
-Required for Interface Development
-**********************************
-
-*At this moment those packages are always required, but the plans are to make them optional.*
+*Future developments will make the following packages optional:*
 
 * `QT 4.8 <http://download.qt.io/archive/qt/4.8/4.8.6/>`_
 * `PIP <https://pip.pypa.io/en/latest/installing.html>`_ (the Python install should have installed pip, try to use it in the next Section before installing)
@@ -102,7 +96,7 @@ Required for Interface Development
 Quick Setup
 -----------
 
-Type the following commands in your terminal. If you are in Windows we recommend you to use Power Shell or similar.
+Type the following commands in your terminal. If you are in Windows we recommend you to use `Power Shell <https://technet.microsoft.com/en-us/scriptcenter/default>`_ or similar.
 
 On OSX/Linux:
 
@@ -126,7 +120,7 @@ On Windows:
   $ pip3 install virtualenv
   $ virtualenv venv
   $ .\venv\Scripts\activate
-  $ pip3 install -r blender-vr/requirements.txt
+  $ pip3 install -r blender-vr\requirements.txt
   $ python3 .\venv\Scripts\pyside_postinstall.py -install
   $ python3 .\blender-vr\blenderVR
 
@@ -136,10 +130,12 @@ You may have to add the path to the python binary, e.g.
 
   $ [Environment]::SetEnvironmentVariable("Path", "$env:Path;C:\Python34\;C:\Python34\Scripts\")
 
+*(For PowerShell to automatically add this path at startup, add this line to a file named e.g. profile.ps1 that you'll place in your WindowsPowerShell directory)*
+
 Running
 -------
 
-Type the following commands in your terminal. If you are in Windows we recommend you to use Power Shell or similar.
+Type the following commands in your terminal. If you are in Windows we recommend you to use `Power Shell <https://technet.microsoft.com/en-us/scriptcenter/default>`_ or similar.
 
 On OSX/Linux:
 
@@ -157,7 +153,14 @@ On Windows:
   $ .\venv\Scripts\activate
   $ python3 .\blender-vr\blenderVR
 
-You should now see a window popping up. Congratulations your installation was a success. Once you are done running Blender-VR you can end the virtual environment:
+You should now see the blenderVR window popping up (see figure below). Congratulations your installation was a success!
+
+.. figure:: /images/user-interface.jpg
+  :width: 300px
+  :figwidth: 300px
+  :align: center
+
+Once you are done running Blender-VR you can end the virtual environment running the command:
 
 .. code-block:: bash