docs: Update README for executing v2 JAR #836
Merged
Conversation
This file contains 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
Previously we didn't have the v2 JAR for people to use, so we had IntelliJ instructions for setting up a Run configuration, etc. This PR replaces the IntelliJ instructions with steps people can take to install Java and run the v2 release JAR. It also adds a Rules section to the README, as this is what most users will be interested in (after running the validator). I also moved "Build the code" towards the bottom near "Architecture", as fewer people are probably interested in that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary:
Previously we didn't have the v2 JAR for people to use, so we had IntelliJ instructions for setting up a Run configuration, etc.
This PR replaces the IntelliJ instructions with steps people can take to install Java and run the v2 release JAR.
It also adds a Rules section to the README, as this is what most users will be interested in (after running the validator).
I also moved "Build the code" towards the bottom near "Architecture", as fewer people are probably interested in that.
Expected behavior:
Users should be able to download and execute the v2 JAR using instructions on the README.
Please make sure these boxes are checked before submitting your pull request - thanks!
gradle testto make sure you didn't break anything