aboutsummaryrefslogtreecommitdiffstats
path: root/docs/build.rst
diff options
context:
space:
mode:
authorDan Timoney <dtimoney@att.com>2017-10-12 09:11:52 -0400
committerDan Timoney <dtimoney@att.com>2017-10-12 10:29:47 -0400
commit93a3119b6922b16ad7b3f41e16427c99b5eac371 (patch)
treecb8e87bd5af56dd9cf447885b667d1e7407ec193 /docs/build.rst
parent6bfed112851ac9d7d30fe942183a633ec9718d46 (diff)
Add readthedocs for sdnc/northbound
Add readthedocs documentation for sdnc/northbound. Change-Id: Iad6b19f8194564807ac5e2b9772a554ab14c2cad Issue-ID: SDNC-72 Signed-off-by: Dan Timoney <dtimoney@att.com>
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