README.md

   1 #==================================================================================\r
   2 \r
   3 #   Copyright (c) 2019 SAMSUNG and AT&T Intellectual Property.\r
   4 #\r
   5 #   Licensed under the Apache License, Version 2.0 (the "License");\r
   6 #   you may not use this file except in compliance with the License.\r
   7 #   You may obtain a copy of the License at\r
   8 #\r
   9 #       http://www.apache.org/licenses/LICENSE-2.0\r
  10 #\r
  11 #   Unless required by applicable law or agreed to in writing, software\r
  12 #   distributed under the License is distributed on an "AS IS" BASIS,\r
  13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  14 #   See the License for the specific language governing permissions and\r
  15 #   limitations under the License.\r
  16 #==================================================================================\r
  17 \r
  18 This repo contains code related to the KPI Monitoring Xapp.\r
  19 Main source code for the xapp is under src/\r
  20 \r
  21 Look at Dockerfile for building instructions\r
  22 \r
  23 \r
  24 NOTE : In order to compile code as a stand alone process, following pre-requisites are required \r
  25 -- 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
  26 \r
  27 -- mdclog library and headers must be installed and available in search path\r
  28 \r
  29 -- hiredis library and headers must be installed and available in search path\r
  30 \r
  31 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