Skip to content

Commit

Permalink
Update README.adoc
Browse files Browse the repository at this point in the history
  • Loading branch information
nathansit committed Mar 16, 2024
1 parent 9ee1cf5 commit f5ce3eb
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

image::https://img.shields.io/twitter/url/https/twitter.com/mvndaemon.svg?style=social&label=Follow%20%40mvndaemon[link="https://twitter.com/mvndaemon"]

toc::[]
:toc:[]

== Introduction

Expand Down Expand Up @@ -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:
+
Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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.
Expand All @@ -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]
Expand Down Expand Up @@ -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 can read 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`
Expand Down

0 comments on commit f5ce3eb

Please sign in to comment.