Update README files in A1 controller

Change-Id: I753f79cfe7c2f2bdae13c9bc3e00eba0d55f1e98
Issue-ID: NONRTRIC-201
Signed-off-by: RehanRaza <muhammad.rehan.raza@est.tech>

diff --git a/sdnc-a1-controller/README.md b/sdnc-a1-controller/README.md
index 477707b..bd0d366 100644 (file)
--- a/sdnc-a1-controller/README.md
+++ b/sdnc-a1-controller/README.md
@@ -1,6 +1,12 @@
 # O-RAN-SC Non-RealTime RIC - A1 Controller
 
-SDNC provides Northbound Interface for A1 operation to do policy management on XAPPS's in Near-RealTime RIC's.
+SDNC-A1 controller provides a Northbound Interface for A1 operations to do policy management in Near-RealTime RICs.
+
+It is a very lightweight version of ONAP SDNC.
+
+Many features/components of SDNC that are not needed for A1 operations have been removed from both northbound and oam directories.
+
+This makes it very fast to start the controller and also puts less load on the CPU.
 
 Please see the documentation in the docs/ folder
 

diff --git a/sdnc-a1-controller/northbound/README.md b/sdnc-a1-controller/northbound/README.md
index 5b9fdfb..0a325f0 100644 (file)
--- a/sdnc-a1-controller/northbound/README.md
+++ b/sdnc-a1-controller/northbound/README.md
@@ -1,9 +1,8 @@
-This source repository contains the code for the SDN-A1 Controller northbound interface adaptors.
-To compile this code:
+This source repository contains the code for the SDNC-A1 Controller northbound interface.
 
-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.
+It contains an OSGI bundle named "nonrt-ric-api" that provides the interface for A1 operations.
 
-2. To compile, run "mvn clean install".
+To compile, run "mvn clean install".
 
 ## License
 

diff --git a/sdnc-a1-controller/oam/README.md b/sdnc-a1-controller/oam/README.md
index 7f74ef7..ce55f56 100644 (file)
--- a/sdnc-a1-controller/oam/README.md
+++ b/sdnc-a1-controller/oam/README.md
@@ -1,4 +1,12 @@
-This source repository contains the code for SDN-A1 Controller operations, administration and maintenance utilities. To compile, run "mvn clean install".
+This source repository contains the code for SDNC-A1 Controller operations, administration and maintenance utilities.
+
+It adds the features from northbound directory and creates the docker image for SDNC-A1 controller.
+
+It also contains the keystore, the script to start OpenDaylight, and the healthcheck script.
+
+The docker-compose file is also included in this directory.
+
+To compile, run "mvn clean install".
 
 ## License