Initial commit for OpenECOMP SDN-C northbound

[sdnc/northbound.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..64be1de
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+This source repository contains the code for the SDN Controller northbound interface adaptors.
+To compile this code:
+
+1. Make sure your local Maven settings file ($HOME/.m2/settings.xml) contains references to the OpenECOMP repositories and OpenDaylight repositories.  See example-settings.xml for an example.
+
+2. To compile, run "mvn clean install".
+
+