summaryrefslogtreecommitdiffstats
path: root/docs/build.rst
diff options
context:
space:
mode:
authorDan Timoney <dtimoney@att.com>2017-10-12 09:18:24 -0400
committerDan Timoney <dtimoney@att.com>2017-10-12 09:18:24 -0400
commit470fa2bf8c8718cbe224156e041c9753a19a08bf (patch)
tree02e93a021054230e6c46a9afb6801f5002a0b7a8 /docs/build.rst
parent79b6224cd7d73c6739bfbd20b90ce5d37fb426e1 (diff)
Add readthedocs for sdnc/oam
Add readthedocs sections for sdnc/oam. Change-Id: I54b725947ef67b494388e919daccc08a7be7dc9b Issue-ID: SDNC-72 Signed-off-by: Dan Timoney <dtimoney@att.com> Former-commit-id: c79ea358129eac458c0515a9ba252f5989c45b4e
Diffstat (limited to 'docs/build.rst')
-rw-r--r--docs/build.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/build.rst b/docs/build.rst
new file mode 100644
index 00000000..0a4c308e
--- /dev/null
+++ b/docs/build.rst
@@ -0,0 +1,18 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Build
+=====
+
+
+Environment
+-----------
+Requires maven release 3.3 or greater
+
+Steps
+-----
+To compile this code:
+
+1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the ONAP repositories and OpenDaylight repositories.
+
+2. To compile, run "mvn clean install". \ No newline at end of file