Adding Bouncer code for RIC-Benchmarking

[ric-app/bouncer.git] / Bouncer / src / README

diff --git a/Bouncer/src/README b/Bouncer/src/README
new file mode 100644 (file)
index 0000000..bfa9d1a
--- /dev/null
+++ b/Bouncer/src/README
@@ -0,0 +1,36 @@
+/*
+# ==================================================================================
+# Copyright (c) 2020 HCL Technologies Limited.
+#
+# 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 Bouncer Xapp developed in C++. Its envisioned to address simple RIC Benchmarking Xapp. 
+It is required to have following features:
+
+1) E2 Subscription Handling
+2) SDL Access
+3) RMR Health Check
+4) RIC Indication
+5) Throughput/Latency of RAN-RIC interaction.
+
+
+
+
+Steps for installation/running Bouncer Xapp.
+
+$ source ./run_xapp.sh
+$ make
+$ ./b_xapp_main