Add a note about using the windows script

This commit is contained in:
Jason van Zyl 2015-04-03 16:04:28 -04:00 committed by rfscholte
parent 00c691df85
commit 8b5a696806
1 changed files with 8 additions and 2 deletions

View File

@ -8,18 +8,24 @@ The easiest way to setup the Maven Wrapper for your project is to use the [Takar
mvn -N io.takari:maven:wrapper mvn -N io.takari:maven:wrapper
``` ```
Normally you might tell users to use the normal `mvn` command like the following: Normally you instruct user to run the `mvn` command like the following:
``` ```
$ mvn clean install $ mvn clean install
``` ```
But now, with a Maven Wrapper setup, you can instruct users to run the following instead: But now, with a Maven Wrapper setup, you can instruct users to run wrapper scripts:
``` ```
$ ./mvnw clean install $ ./mvnw clean install
``` ```
or
```
$ ./mvnw.bat clean install
```
A normal Maven build will be executed with the one important change that if the user doesn't have the necessary version of Maven specified in `.mvn/wrapper/maven-wrapper.properties` it will be downloaed for the user first. A normal Maven build will be executed with the one important change that if the user doesn't have the necessary version of Maven specified in `.mvn/wrapper/maven-wrapper.properties` it will be downloaed for the user first.
[1]: https://github.com/takari/takari-maven-plugin [1]: https://github.com/takari/takari-maven-plugin