docs: reorganize docs for the sphinx build

Reorganize docs into the appropriate folders for the new sphinx build.
JIRA: VSPERF-80

Change-Id: I9dcd74e092ce52546a0986b92a1ebb2b5b7419bf
Signed-off-by: Ramprasad Velavarthipati <ram.v@freescale.com>
Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Reviewed-by: Trinath Somanchi <trinath.somanchi@gmail.com>

1 files changed, 44 insertions, 0 deletions

diff --git a/docs/guides/installation.rst b/docs/guides/installation.rst
new file mode 100755
index 00000000..272993ef
--- /dev/null
+++ b/docs/guides/installation.rst
@@ -0,0 +1,44 @@
+Installing vswitchperf
+======================
+
+The test suite requires Python 3.3 and relies on a number of other
+packages. These need to be installed for the test suite to function. To
+install Python 3.3 in CentOS 7, an additional repository, Software
+Collections (see
+https://www.softwarecollections.org/en/scls/rhscl/python33) should be
+enabled.
+
+Installation of required packages and preparation of Python 3 virtual
+environment is performed by systems/build_base_machine.sh. It should be
+executed under user account, which will be used for vsperf execution.
+Password less sudo access must be configured for given user account
+before script is executed.
+
+Execution of installation script:
+
+.. code:: bash
+
+    cd systems
+    ./build_base_machine.sh
+
+You need to activate the virtual environment every time you start a new
+shell session. To activate, simple run:
+
+.. code:: bash
+
+    scl enable python33 bash
+    cd vsperfenv
+    source bin/activate
+
+--------------
+
+Working Behind a Proxy
+======================
+
+If you're behind a proxy, you'll likely want to configure this before
+running any of the above. For example:
+
+  .. code:: bash
+
+    export http_proxy=proxy.mycompany.com:123
+    export https_proxy=proxy.mycompany.com:123