Add build config in README 20/108820/2
authorsebdet <sebastien.determe@intl.att.com>
Fri, 5 Jun 2020 10:55:28 +0000 (12:55 +0200)
committerOfir Sonsino <ofir.sonsino@intl.att.com>
Wed, 10 Jun 2020 08:21:42 +0000 (08:21 +0000)
Add a required step to build the project, the oparent settings.xml must be installed first in .m2

Issue-ID: SDC-2871
Change-Id: Id69582582849a8937f4e76d24d6a6bfdc8f0a957
Signed-off-by: sebdet <sebastien.determe@intl.att.com>
README.md

index 6e69c4b..8465dbe 100644 (file)
--- a/README.md
+++ b/README.md
@@ -50,7 +50,9 @@ SDC is built from several projects while the parent "sdc" contains the main pom.
 - sdc-os-chef          - chefs scripts used for docker creation and startup
 - utils                        - set of dev utils used for working with the project locally
 
-In order to build all the projects, go to sdc project and run the command: `mvn clean install`
+
+In order to build all the projects, as mentioned in the onap wiki https://wiki.onap.org/display/DW/Setting+Up+Your+Development+Environment, the settings.xml (https://git.onap.org/oparent/plain/settings.xml) from the oparent project must be installed in your ~/.m2 folder and referenced by your IDE.
+Once maven is set up properly, go to sdc project and run the command: `mvn clean install`
 
 Currently SDC build process also supports docker building.
 Note that if you're working on Windows, you'll need to define an environment variable on your machine with key `DOCKER_HOST` and value: `tcp://<ip_address>:2375` in order to build and upload local dockers to a local environment.