summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..98b67fb0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+This source repository contains the code for SDN Controller operations, administration and maintenance utilities. This code depends on the following, which should be downloaded and compiled first:
+
+1. org.openecomp.sdnc/sdnc-core
+2. org.openecomp.sdnc/sdnc-adaptors
+3. org.openecomp.sdnc/sdnc-northbound
+4. org.openecomp.sdnc/sdnc-plugins
+
+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".
+
+