summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use/index.rst
diff options
context:
space:
mode:
authorspisarski <s.pisarski@cablelabs.com>2017-02-15 12:07:07 -0700
committerspisarski <s.pisarski@cablelabs.com>2017-02-15 15:23:39 -0700
commitc5301a7a2e890fed97ffe04b40ccbe331e7f4a0b (patch)
tree72e5715cb7496d5826e6b0fea9652c969bf75f2b /docs/how-to-use/index.rst
parent57777f3df521553a06cd01a3861b415d2905ceca (diff)
Converted existing markdown documentation to RST format.
Removed MD versions. Moved examples directory up one under repo root Moved RST files under docs/how-to-use Change-Id: I4137b8591e4ae63e40674a7f5f8243d928efee0c Signed-off-by: spisarski <s.pisarski@cablelabs.com>
Diffstat (limited to 'docs/how-to-use/index.rst')
-rw-r--r--docs/how-to-use/index.rst26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/how-to-use/index.rst b/docs/how-to-use/index.rst
new file mode 100644
index 0000000..58b67a3
--- /dev/null
+++ b/docs/how-to-use/index.rst
@@ -0,0 +1,26 @@
+*************************
+Runtime Environment Setup
+*************************
+
+- Python 2.7 (recommend leveraging a Virtual Python runtime, e.g.
+ `Virtualenv <https://virtualenv.pypa.io>`__, in your development
+ environment)
+- Development packages for python and openssl. On CentOS/RHEL:
+
+ # yum install python-devel openssl-devel
+
+On Ubuntu:
+
+::
+
+ # apt-get install python2.7-dev libssl-dev
+
+- Install SNAPS Library
+
+ - pip install -e <path to repo>/snaps/
+
+`Testing <Testing.rst>`__
+-------------------------
+
+`Virtual Environment Deployment <VirtEnvDeploy.rst>`__
+------------------------------------------------------