From 406584267b076f60c54d6cfef518dc22a82ae76c Mon Sep 17 00:00:00 2001 From: randyl Date: Fri, 3 Mar 2017 15:30:05 -0700 Subject: 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 --- docs/how-to-use/InstallSnaps.rst | 44 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 docs/how-to-use/InstallSnaps.rst (limited to 'docs/how-to-use/InstallSnaps.rst') 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 `__, 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 /snaps/ + +The install should now be complete and you can start using the SNAPS-OO libraries. -- cgit 1.2.3-korg