Merge "Small change installation guide A1 Controller"
[nonrtric.git] / sdnc-a1-controller / northbound / README.md
index 64be1de..0a325f0 100644 (file)
@@ -1,8 +1,23 @@
-This source repository contains the code for the SDN 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
+
+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.