Adding initial code jy.oak@samsung.com

[ric-app/kpimon.git] / README.md

diff --git a/README.md b/README.md
new file mode 100755 (executable)
index 0000000..66f71f2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+#==================================================================================\r
+\r
+#        Copyright (c) 2018-2019 AT&T Intellectual Property.\r
+#\r
+#   Licensed under the Apache License, Version 2.0 (the "License");\r
+#   you may not use this file except in compliance with the License.\r
+#   You may obtain a copy of the License at\r
+#\r
+#       http://www.apache.org/licenses/LICENSE-2.0\r
+#\r
+#   Unless required by applicable law or agreed to in writing, software\r
+#   distributed under the License is distributed on an "AS IS" BASIS,\r
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+#   See the License for the specific language governing permissions and\r
+#   limitations under the License.\r
+#==================================================================================\r
+\r
+This repo contains code related to the KPI Monitoring Xapp.\r
+Main source code for the xapp is under src/\r
+\r
+Look at Dockerfile for building instructions\r
+\r
+\r
+NOTE : In order to compile code as a stand alone process, following pre-requisites are required \r
+-- For compilation, the nanomsg, nng and ric messaging libraries, as well as ric messaging header must be installed in standard paths (or if non-default, then visible in search paths)\r
+\r
+-- mdclog library and headers must be installed and available in search path\r
+\r
+-- hiredis library and headers must be installed and available in search path\r
+\r
+The run_xapp.sh script provides a convenient way to set the various parameters and invoke the process (if not running in a docker container)\r