Switching to riclibe2ap

[ric-app/hw.git] / README

diff --git a/README b/README
index 9945315..d567811 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,42 @@
-#Future directory for HELLOWORLD
+==================================================================================
+
+        Copyright (c) 2019-2020 AT&T Intellectual Property.
+
+   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.
+==================================================================================
+
+This repository consists of HelloWorld Xapp developed in C++. Its envisioned to be the most simplest example Xapp. 
+It is required to have following features
+
+1) E2 Subscription Handling
+2) A1 Policy Handling
+3) DB Access: SDL and RNIB
+4) RMR Health Check/A1 Health Check
+5) Helloworld E2SM
+6) RNIB GNB Retrival
+7) ....
+
+
+
+
+Steps for installation/running HWXapp.
+$ cd init
+$ source ./xapp_env.sh
+$cd ../src
+$ make
+$ ./hw_xapp_main
+
+Steps for running test scripts.
+$cd test
+$make
+$./hw_unit_tests