Skip to content

Update the README.md file #660

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.

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

Merged
merged 3 commits into from
Apr 9, 2025
Merged

Update the README.md file #660

merged 3 commits into from
Apr 9, 2025

Conversation

leerho
Copy link
Contributor

@leerho leerho commented Apr 8, 2025

The previous README was out-of-date and referring to Java 17. This has been completely updated and reflects the subtle issues of compiling and running this version with Java 21 and possibly later versions.

Copy link
Contributor

@jmalkin jmalkin left a comment

Choose a reason for hiding this comment

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

A couple super small things to fix so I'll approve so you don't need another review round. But they're tiny so please fix.

README.md Outdated
```
### OpenJDK Version 21
An OpenJDK-compatible build of Java 21, provided by one of the Open-Source providers, such as Azul Systems, Red Hat, SAP, Eclipse Temurin, etc, is required.
All of the testing of this release has been performed with a Eclipse Temurin build.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: an Eclipse Temurin...

README.md Outdated
#### A Toolchain is required

* You must have a JDK type toolchain defined in location *~/.m2/toolchains.xml* that specifies where to find a locally installed OpenJDK-compatible version 21.
* Your default \$JAVA\_HOME compiler must be an OpenJDK compatible, specified in the toolchain, and may be a version greater than 21. Note that if your \$JAVA\_HOME is set to a Java version greater than 21, Maven will automatically use the Java 21 version specified in the toolchain instead. The included pom.xml specifies the necessary JVM flags, so no further action should be required.
Copy link
Contributor

Choose a reason for hiding this comment

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

"an OpenJDK compatible, ..." -- either remove "an" or add a word somewhere

@leerho leerho merged commit 0684f34 into main Apr 9, 2025
7 checks passed
@leerho leerho deleted the fix_readme branch April 9, 2025 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants