From 64f57d8e05e56fb1c1ac964795b785b081f59cad Mon Sep 17 00:00:00 2001 From: Fiete Ostkamp Date: Tue, 27 Dec 2022 12:20:23 +0000 Subject: Minor improvements for the README - fix broken link to architecture picture - improve document structure - improve cds-ui/server README Issue-ID: CCSDK-3825 Signed-off-by: Fiete Ostkamp Change-Id: I00087a8fa31bad2c4bcaebae487940e7af4807c0 --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index fc87d1264..a95b9c47e 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,7 @@ -### Format code with ktlint checkstyle tool use the following command -`mvn process-sources -P format` - -**Reference:** [ktlint docs](https://ktlint.github.io/) | [ktlint codebase](https://github.com/pinterest/ktlint) +# Controller Design Studio (CDS) ## Basic Architecture -![Basic_Architecture](./docs/media/CDS.png) +![Basic_Architecture](./docs/media/CDS_architecture.jpg) ## Basic Requirements Before you can build this project, you must install and configure the following dependencies on your machine: @@ -15,8 +12,8 @@ Before you can build this project, you must install and configure the following 5) Angular CLI & Angular v8 ## Running in Development Mode -Running `mvn clean install` command to install all libraries and dependencies for the maven and npm. -Running `mvn clean install -Pdocker` command to install all libraries and create below docker images. +Run `mvn clean install` command to install all libraries and dependencies for the maven and npm. +Run `mvn clean install -Pdocker` command to install all libraries and create below docker images. * ccsdk-blueprintsprocessor * ccsdk-commandexecutor * ccsdk-py-executor @@ -24,7 +21,7 @@ Running `mvn clean install -Pdocker` command to install all libraries and create * ccsdk-cds-ui-server * ccsdk-cds-ui -**Note:** run `mvn clean install -Pdocker -Ddocker.skip.push=true` to build but skip pushing docker image. +**Note:** Run `mvn clean install -Pdocker -Ddocker.skip.push=true` to build but skip pushing docker image. 1) Back-end MS >Create `sdnctl` table in MySQL
@@ -43,4 +40,9 @@ Running `mvn clean install -Pdocker` command to install all libraries and create **Back-end:** `IntelliJ` with kotlin plugin or any other editor --- -For more information check: [CDS Docs](https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html) \ No newline at end of file +For more information check: [CDS Docs](https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html) + +### Format code with ktlint checkstyle tool use the following command +`mvn process-sources -P format` + +**Reference:** [ktlint docs](https://ktlint.github.io/) | [ktlint codebase](https://github.com/pinterest/ktlint) -- cgit 1.2.3-korg