summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorsebdet <sebastien.determe@intl.att.com>2020-06-05 12:55:28 +0200
committerOfir Sonsino <ofir.sonsino@intl.att.com>2020-06-10 08:21:42 +0000
commitcd48e77d908377315d03ffc1dc136b1d96c0c477 (patch)
tree010a65c06afc0dfdf5781c21e63ba85ead333b0b /README.md
parent966271e4e2601d58eb06f286a3b2921e803fa9af (diff)
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 <sebastien.determe@intl.att.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
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://<ip_address>:2375` in order to build and upload local dockers to a local environment.