Update README files in A1 controller

[nonrtric.git] / sdnc-a1-controller / oam / README.md

diff --git a/sdnc-a1-controller/oam/README.md b/sdnc-a1-controller/oam/README.md
index 98b67fb..ce55f56 100644 (file)
--- a/sdnc-a1-controller/oam/README.md
+++ b/sdnc-a1-controller/oam/README.md
@@ -1,14 +1,28 @@
-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:
+This source repository contains the code for SDNC-A1 Controller operations, administration and maintenance utilities.
 
-1. org.openecomp.sdnc/sdnc-core
-2. org.openecomp.sdnc/sdnc-adaptors
-3. org.openecomp.sdnc/sdnc-northbound
-4. org.openecomp.sdnc/sdnc-plugins
+It adds the features from northbound directory and creates the docker image for SDNC-A1 controller.
 
-To compile this code:
+It also contains the keystore, the script to start OpenDaylight, and the healthcheck script.
 
-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.
+The docker-compose file is also included in this directory.
 
-2. To compile, run "mvn clean install".
+To compile, run "mvn clean install".
+
+## License
+
+Copyright (C) 2019 Nordix Foundation.
+Licensed under the Apache License, Version 2.0 (the "License")
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+For more information about license please see the [LICENSE](LICENSE.txt) file for details.