X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.md;h=a95b9c47e809fbd7fb39a7ceebbd9e1dfd28facb;hb=refs%2Fheads%2Fmaster;hp=fc87d1264743ee3fba1bde5965184699868ce188;hpb=d97021cd756d63402545fdc2e14ac7611c3da118;p=ccsdk%2Fcds.git 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)