Update the README.md file #660
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmalkin
approved these changes
Apr 8, 2025
Contributor
jmalkin
left a comment
jmalkin
left a comment
There was a problem hiding this comment.
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. |
Contributor
There was a problem hiding this comment.
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. |
Contributor
There was a problem hiding this comment.
"an OpenJDK compatible, ..." -- either remove "an" or add a word somewhere
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.