X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=README.md;h=e70617f58b7c5fb2261e0cac6b1ec6950ffc323f;hb=refs%2Fchanges%2F37%2F537%2F12;hp=5553352c7a68574485383a079b3ffe9cafec3db7;hpb=e2cbc4d0304646febf7e2cbe0dccdf9840189222;p=portal%2Fric-dashboard.git

diff --git a/README.md b/README.md
index 5553352c..e70617f5 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,39 @@
-# ORAN-OSC RIC Dashboard Web Application
+# O-RAN-SC RIC Dashboard Web Application
 
-This webapp is built with Angular 7 and Spring-Boot 2.
+The O-RAN SC RIC Dashboard provides administrative and operator functions
+for a disaggregated radio access network (RAN) controller.
+The web app is built as a single-page app using an Angular 8 front end
+and a Spring-Boot 2 back end.
 
-## Getting started
+## Deployment configuration
 
-To install prerequisites on Mac OSX, first install nvm then continue with node:
+The application expects the following configuration files,
+usually mounted as files from Kubernetes configuration maps:
 
-	curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.0/install.sh | bash
+    application.properties (in launch directory)
+    key.properties (on classpath)
+    portal.properties (on classpath)
 
-Then:
+Sample files are in directory src/main/resources and src/test/resources.
 
-	nvm install stable
-	nvm install node
+## Development guide
 
-To run the web app:
+This section gives a quickstart guide for developers.
 
-    cd ric-dashboard/ang7-sb2
-    mvn clean install
+### Prerequisites
 
-    cd ric-dashboard/ang7-sb2/backend/
-    mvn spring-boot:run
+1. Java development kit (JDK), version 11 or later
+2. Maven dependency-management tool, version 3.4 or later
 
-To debug the frontend and backend for Angular developers:
+### Build and launch the web app
 
-    cd ric-dashboard/ang7-sb2/frontend/src/main/web/src/app
-    ./ng serve --proxy-config proxy.conf.json
+Instructions for launching a backend Sprint-Boot server
+are available in the webapp-backend README file.
+After launching, open a browser on http://localhost:8080
+
+Instructions for launching a frontend Angular server (only for development)
+are available in the webapp-frontend README file.
+After launching, open a browser on http://localhost:4200
 
 ## License