Skip to content

Commit d8e51da

Browse files
authored
Update README.md with build instructions
[skip ci] Signed-off-by: Ash <73482956+ascopes@users.noreply.github.com>
1 parent ebf69fa commit d8e51da

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

README.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,46 @@ holding the flags you wish to use.
345345
has a high churn of objects. On Java 11, the ZGC is an experimental feature, which needs
346346
to be enabled with `-XX:+UnlockExperimentalOptions -XX:+UseZGC`. On Java 17, you just
347347
need to pass `-XX:+UseZGC` alone.
348-
348+
349+
## Building this project
350+
351+
This project uses Java 11, and bootstraps Maven using the Maven Wrapper tooling. This means that
352+
all you need to build this is any JDK from Java 11
353+
onwards: everything else will be set up automatically for you.
354+
355+
### Non-Windows
356+
357+
On Linux, BSD, and MacOS, I tend to use [sdkman!](https://sdkman.io/) to install the JDK I want to use:
358+
359+
```shell
360+
# Install sdkman
361+
$ curl -s "https://get.sdkman.io" | bash
362+
$ source "$HOME/.sdkman/bin/sdkman-init.sh"
363+
364+
# See what versions of Java are available
365+
$ sdk list java
366+
367+
# Install a JDK of my choice, like Amazon Corretto
368+
$ sdk install java x.y.z-amzn
369+
```
370+
371+
Once that is configured, you can just run the Maven Wrapper shell script to download, install,
372+
and run the correct version of Maven:
373+
374+
```shell
375+
$ ./mvnw clean package
376+
```
377+
378+
### Windows
379+
380+
On Windows, you can install the JDK of your choice directly from their website, or use Chocolatey to
381+
install it for you. Once installed, you can just run the Maven Wrapper batch script to download,
382+
install, and run the correct version of Maven:
383+
384+
```cmd
385+
.\mvnw.cmd clean package
386+
```
387+
349388
## ECJ support
350389

351390
While this module initially supported ECJ, there were a number of problems relating to bugs

0 commit comments

Comments
 (0)