From cd48e77d908377315d03ffc1dc136b1d96c0c477 Mon Sep 17 00:00:00 2001 From: sebdet Date: Fri, 5 Jun 2020 12:55:28 +0200 Subject: Add build config in README 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 --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6e69c4bc29..8465dbefd3 100644 --- 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://:2375` in order to build and upload local dockers to a local environment. -- cgit 1.2.3-korg