apache/maven-mvnd
1
0
Fork 0
mirror of https://github.com/apache/maven-mvnd.git synced 2026-01-13 07:04:14 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Update README.adoc

Browse Source
This commit is contained in:
Nathan Sit
2024-03-15 10:45:34 -07:00
committed by Peter Palaga
parent f6a6747b04
commit 90b505a9e7
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.adoc
View File

@@ -35,8 +35,8 @@ This architecture brings the following advantages:
* By default, `mvnd` is building your modules in parallel using multiple CPU cores. The number of utilized cores is
given by the formula `Math.max(Runtime.getRuntime().availableProcessors() - 1, 1)`. If your source tree does not
support parallel builds, pass `-T1` on the command line to make your build serial.
* Improved console output: we believe that the output of a parallel build on a stock Maven is hard to follow. Therefore,
support parallel builds, pass `-T1` into the command line to make your build serial.
* Improved console output: we believe that the output of a parallel build on stock Maven is hard to follow. Therefore,
we implemented a simplified non-rolling view showing the status of each build thread on a separate line. This is
what it looks like on a machine with 24 cores:
+
@@ -70,7 +70,7 @@ $ brew install mvndaemon/homebrew-mvnd/mvnd
We're looking for contribution to support https://www.macports.org[MacPorts],
https://community.chocolatey.org/packages/mvndaemon/[Chocolatey], https://scoop.sh/[Scoop] or
https://github.com/joschi/asdf-mvnd#install[asdf]. If you're fancy helping us...
https://github.com/joschi/asdf-mvnd#install[asdf]. If you fancy helping us...
////
=== Install using https://www.macports.org[MacPorts]
@@ -108,7 +108,7 @@ $ asdf install mvnd latest
Optionally, you can set up completion as follows:
[source,shell]
----
# ensure to set MVND_HOME to point to your mvnd distribution, note that sdkman does it for you
# ensure that MVND_HOME points to your mvnd distribution, note that sdkman does it for you
$ echo 'source $MVND_HOME/bin/mvnd-bash-completion.bash' >> ~/.bashrc
----
`bash` is the only shell supported at this time.
@@ -128,7 +128,7 @@ $ unalias mvnd
* Unzip to a directory of your choice
* Add the `bin` directory to `PATH`
* Optionally, you can create `~/.m2/mvnd.properties` and set the `java.home` property in case you do not want to bother
with setting `JAVA_HOME` environment variable.
with setting the `JAVA_HOME` environment variable.
* Test whether `mvnd` works:
+
[source,shell]
@@ -168,11 +168,11 @@ mvnd verify
`--stop` kills all running daemons
The complete list of options is printed when executing `mvnd --help`.
`mvnd --help` prints the complete list of options
== Configuration
Configuration can be provided through properties file. Mvnd read properties file from the following locations:
Configuration can be provided through the properties file. Mvnd reads the properties file from the following locations:
* the properties path supplied using `MVND_PROPERTIES_PATH` environment variable or `mvnd.propertiesPath` system variable
* the local properties path located at `[PROJECT_HOME]/.mvn/mvnd.properties`