Add script to start PMS and add policy type

[nonrtric/rapp/healthcheck.git] / README.md

diff --git a/README.md b/README.md
index af87608..d6a8ac9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,24 +6,33 @@ The Health Check use case test provides a python script that regularly creates,
 in all Near-RT RICs that support the type used by the script. A self refreshing web page provides a view of statistics
 for these regular checks.
 
-## Prerequisits
+## Prerequisites
 
 To run this script Python3 needs to be installed. To install the script's dependencies, run the following command from
 the `src` folder: `pip install -r requirements.txt`
 
 ## How to run
 
-Go to the `src/` folder and run `python3 main.py`. The script will start and run until stopped. Use the `-h` option to
+To start the Policy Management Service (PMS) and RIC simulators and install the default policy type, do the following:
+
+1. Go to the `test` folder.
+2. Check that the `start.sh` script has the correct versions of PMS and simulators. If not, update it to the correct versions.
+3. Run the `start.sh` script.
+4. The script will finnish when the policy type is registered and synched in PMS.
+
+To start the use case, go to the `src/` folder and run `python3 main.py`. The script will start and run until stopped. Use the `-h` option to
 see the options available for the script.
 
 As default, the script uses the "Hello World" policy type with ID "2". To create the instances it uses the body file
 `nonrtric/test/autotest/testdata/OSC/pihw_template.json`. The body file contains the string "XXX" as a parameter value.
-This string vill be replaced with dynamic data during creation. It is possible to provide a custom policy type and
+This string will be replaced with dynamic data during creation. It is possible to provide a custom policy type and
 body file to the script at startup.
 
 To see the web page, navigate to `localhost:9990/stats`. The page refreshes itself with the same interval as the script
 uses.
 
+To stop PMS and the simulators, run the `stop.sh` script.
+
 ## License
 
 Copyright (C) 2020-2022 Nordix Foundation.