summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorspisarski <s.pisarski@cablelabs.com>2018-04-12 13:20:52 -0600
committerspisarski <s.pisarski@cablelabs.com>2018-04-12 16:12:12 -0600
commitbf07de830d7517f7173a3e8a68e1fa6dac2539da (patch)
treed923e57f72720e768d6b106b3a3a0518a5c67aa2
parentf776a8606ef1efb8697eee3c67d8ae6571c4a743 (diff)
Initial release-notes.
JIRA: SNAPS-288 Change-Id: I61e96eeb2128fc4e4abc88595504cad5f70f4378 Signed-off-by: spisarski <s.pisarski@cablelabs.com>
-rw-r--r--docs/release/release-notes.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst
new file mode 100644
index 0000000..d682dd9
--- /dev/null
+++ b/docs/release/release-notes.rst
@@ -0,0 +1,25 @@
+=================
+SNAPS-OO in OPNFV
+=================
+
+Introduction
+============
+
+SNAPS-OO is a object-oriented library designed for managing objects deployed
+on OpenStack. In addition to its ability to deploy and manage objects, this
+project also contains many API and integration tests that can be used to
+validate your OpenStack cloud. Also included is a lightweight orchestrator that
+can be used for rapid prototyping virtual environments.
+
+Installation
+============
+
+To use SNAPS-OO, it must first be installed into your Python 2.7-3.5 runtime.
+To install:
+
+pip install -e <SNAPS-OO directory>
+
+Using SNAPS-OO
+==============
+
+Please refer to the RST documents in ../how-to-use \ No newline at end of file