From: kaihlavi Date: Mon, 24 Jun 2019 13:13:07 +0000 (+0300) Subject: Highlight Windows-specific parts X-Git-Tag: 1.6.1~258 X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=9ed7972644ab771b37c3f40ec3c7c7c2a666ef8a;p=sdc.git Highlight Windows-specific parts Change-Id: I8da91c11d772d7b2ec487506431d172d414ddace Issue-ID: SDC-2386 Signed-off-by: kaihlavi --- diff --git a/README.md b/README.md index 3a43db09ce..6e69c4bc29 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ There are four major components of SDC: ## Git Configuration -Before cloning the sdc source code it's important to enable long paths on your Windows machine, otherwise git won't be able to handle some files +Note that if you're working on Windows, it's important to enable long paths for your machine; otherwise git won't be able to handle some files. In order to do so just add this section to your global git.config file under the `[core]` key: @@ -53,8 +53,9 @@ SDC is built from several projects while the parent "sdc" contains the main pom. In order to build all the projects, go to sdc project and run the command: `mvn clean install` Currently SDC build process also supports docker building. -In order to build and upload local dockers to a local environment you'll need to define an environment variable on your machine with key: `DOCKER_HOST` and value: `tcp://:2375` -For the dockers to be built during the build process use the "docker" profile by adding this: `-P docker` to the `mvn clean install` command +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. + +For the dockers to be built during the build process use the "docker" profile by adding `-P docker` to the `mvn clean install` command More flags to use in the build process are: * -DskipTests - Skips unit tests execution