Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.adoc #925

Merged
merged 1 commit into from
Mar 18, 2024
Merged

Update README.adoc #925

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
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...
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-1 on this change. The original was correct IMO.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a native speaker, but IIUC the original is incorrect, and the suggestion is correct. See also examples e.g. here.

Copy link
Contributor Author

@nathansit nathansit Mar 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can see it being written as "If you are fancy, help us" or something along those lines. But I haven't heard that turn of phrase too often either.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing to an evidence, gentlemen. I did not know "fancy" was also a verb.


////
=== 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 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`
Expand Down
Loading