Apache
/
maven
mirror of https://github.com/apache/maven.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update the README.md with instructions

This commit is contained in:
Jason van Zyl 2015-04-03 15:18:39 -04:00 committed by rfscholte
parent 5994302454
commit 70d1052dbc
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
maven-wrapper/README.md
View File

@ -1,11 +1,25 @@
This is a copy of the gradle wrapper ported for use with maven.
# Maven Wrapper
To run this build as an example run the 'mvnw' script at the root of this repo as you would normally run 'mvn'
For example if you typically run
The Maven Wrapper is an easy way to ensure a user of your Maven build has everything necessary run your Maven build. Why might this be necessary? Maven to date has been very stable for users, is available on most systems or is easy to procure, but with many of the recent changes in Maven it will be easier for users to have a fully encapsulated build setup provided by a project. With the Maven Wrapper this is very easy to do and it's a great idea borrowed from Gradle.
$ mvn clean install
The easiest way to setup the Maven Wrapper for your project is to use the [Takari Maven Plugin][1] with its provided `wrapper` goal. To add all the necessary Maven Wrapper files to your project execute the following command:
then run
```
mvn -N io.takari:maven:wrapper
```
$ ./mvnw clean install
Normally you might tell users to use the normal `mvn` command like the following:
```
$ mvn clean install
```
But now, with a Maven Wrapper setup, you can instruct users to run the following instead:
```
$ ./mvnw 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.
[1]: https://github.com/takari/takari-maven-plugin