Conversation
Updated README to reflect changes in JDK and JRE requirements, added installation instructions, and clarified arguments and options.
Neutra1l
force-pushed
the
Neutra1l-patch-1
branch
from
September 6, 2026 11:48
2f86ef4 to
213095c
Compare
koppor
requested changes
Sep 26, 2026
| ## Run with JBang | ||
|
|
||
| With [JBang](https://www.jbang.dev/) installed (requires JRE 21 or newer), the | ||
| With [JBang](https://www.jbang.dev/) installed (requires JRE 25 or newer), the |
Member
There was a problem hiding this comment.
Suggested change
| With [JBang](https://www.jbang.dev/) installed (requires JRE 25 or newer), the | |
| With [JBang](https://www.jbang.dev/) installed (Java 8 is the minimum required version, however Java 17 or higher is recommended), the |
JBang installs the required JDK on its own: https://www.jbang.dev/documentation/jbang/latest/javaversions.html
|
|
||
| Installing the tool as a native executable is highly recommended. | ||
|
|
||
| Head over to Release, download either the tarball or the `.zip` file depending on your operating system. Extract it to a directory and add it to your system PATH. |
Member
There was a problem hiding this comment.
Add link to"Release" - otherwise unclear what this means.
|
|
||
| 1. Build and grab dependencies with: `.\gradlew build` | ||
| 2. Test the tool with: `.\gradlew run --args="[Options] <madrFile>"` | ||
| Working with this repository locally requires Java SDK 25 or newer and Rust to be installed on your system. |
Member
There was a problem hiding this comment.
Oh, there is no Gradle toolchain in place? If it was, Java 17 would be the minimum required version - see https://docs.gradle.org/current/userguide/compatibility.html
| 2. Test the tool with: `.\gradlew run --args="[Options] <madrFile>"` | ||
| Working with this repository locally requires Java SDK 25 or newer and Rust to be installed on your system. | ||
|
|
||
| 1. Build and grab dependencies on the Rust side with `cargo build --release` inside `app\native\rust` |
Member
There was a problem hiding this comment.
No version constraint on cargo? Is cargo from 2023 working?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Updated README to reflect changes in JDK and JRE requirements, added installation instructions, and clarified arguments and options.