summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use/InstallSnaps.rst
diff options
context:
space:
mode:
authorrandyl <r.levensalor@cablelabs.com>2017-03-03 15:30:05 -0700
committerrandyl <r.levensalor@cablelabs.com>2017-03-03 15:30:05 -0700
commit406584267b076f60c54d6cfef518dc22a82ae76c (patch)
tree2294dc736992a8621d90c40938cf04bc4622608a /docs/how-to-use/InstallSnaps.rst
parentbadc81a7ff469e02303a729c7544216258d40239 (diff)
Fixed docs build and examples
Modified index.rst to include the other docs. Removed redundnat items. Cleaned up the examples. JIRA: SNAPS-41 Change-Id: I7058f1604135f6a2af0376d7b3d2ebc7bafd63e7 Signed-off-by: randyl <r.levensalor@cablelabs.com>
Diffstat (limited to 'docs/how-to-use/InstallSnaps.rst')
-rw-r--r--docs/how-to-use/InstallSnaps.rst44
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/how-to-use/InstallSnaps.rst b/docs/how-to-use/InstallSnaps.rst
new file mode 100644
index 0000000..9412579
--- /dev/null
+++ b/docs/how-to-use/InstallSnaps.rst
@@ -0,0 +1,44 @@
+****************
+Installing SNAPS
+****************
+
+
+Install Dependencies
+====================
+A few packages need to installed onto your system, before you can install SNAPS.
+
+Git is used to download the snaps source from the OPNFV Gerrit repository.
+
+Python, GCC and additional libraries are required to compile and install the packages used by SNAPS. These
+dependencies need to be installed whether or not a virtual Python environment is used.
+
+CentOS 7
+--------
+
+::
+
+ # yum install -7 git gcc python-pip python-devel openssl-devel
+
+Ubuntu
+------
+::
+
+ # apt-get install git python2.7-dev libssl-dev
+
+Optional: Setup a Python virtual environment
+--------------------------------------------
+
+Python 2.7 (recommend leveraging a Virtual Python runtime, e.g.
+ `Virtualenv <https://virtualenv.pypa.io>`__, in your development
+ environment)
+
+Install SNAPS dependencies
+--------------------------
+
+The "pip" command below needs to be executed as root, if you are not using a virtual Python environment.
+
+::
+
+ # pip install -e <path to repo>/snaps/
+
+The install should now be complete and you can start using the SNAPS-OO libraries.