docs: Migrate Docs to RST format and new dir docs/

Migrate all existing VSPERF documentation to a new directory called
docs/ and convert to ReStructuredText format. It's recommended that any
doc changes in the future are tested with: http://rst.ninjs.org/.

Change-Id: I18aa574b1259986502bde4ceef1fae7c6a5c1f33
JIRA: VSPERF-60

Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>
Reviewed-by: Eugene Snider <Eugene.Snider@huawei.com>
Reviewed-by: Gurpreet Singh <gurpreet.singh@spirent.com>
Reviewed-by: Tv Rao <tv.rao@freescale.com

1 files changed, 68 insertions, 0 deletions

diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644
index 00000000..e9a3d115
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,68 @@
+Installing toit
+===============
+
+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.
+
+Install the requirements as specified below.
+
+Enable Software Collections (SCL)
+---------------------------------
+
+  .. code-block:: console
+
+   yum -y install scl-utils
+   yum -y install https://www.softwarecollections.org/en/scls/rhscl/python33/epel-7-x86_64/download/rhscl-python33-epel-7-x86_64.noarch.rpm
+
+System packages
+-----------------
+There are a number of packages that must be installed using `yum`. These can be installed like so:
+
+  .. code-block:: console
+
+   yum -y --exclude=python33-mod_wsgi* install python33-* pciutils
+
+
+Python 3 Packages
+-----------------
+
+To avoid file permission errors and Python version issues, use
+virtualenv to create an isolated environment with Python3. The required
+Python 3 packages can be found in the ``requirements.txt`` file in the
+root of the test suite. They can be installed in your virtual
+environment like so:
+
+  .. code-block:: bash
+
+    scl enable python33 bash
+    # Create virtual environment
+    virtualenv vsperfenv
+    cd vsperfenv
+    source bin/activate
+    pip install -r requirements.txt
+
+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