Skip to content

Fix grammar and improve phrasing in README.adoc #239

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.

Sign up for GitHub

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
mkoncek merged 1 commit into from
Jul 9, 2025
Merged

Fix grammar and improve phrasing in README.adoc #239

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ In short, javapackages-validator helps maintain Java packaging quality and consi

== Key features and purpose

* Metadata Validation: Ensures Java packages correctly declare dependencies, provides, requires, and build-time requirements.
* Metadata Validation: Ensures Java packages correctly declare their Provides, Requires, and build-time dependencies.

* Java Packaging Standards: Helps maintain consistency across RPM-based distributions by verifying adherence to Java packaging standards (e.g., naming conventions, dependencies management).
* Java Packaging Standards: Helps maintain consistency across RPM-based distributions by verifying adherence to Java packaging standards (e.g., naming conventions, dependency management).

* Error Detection: Reports issues such as missing metadata, incorrect versioning, or improper handling of Java dependencies, allowing developers and maintainers to correct issues before package distribution.

== When is it used?
== When it is used

* By Java package maintainers or developers preparing RPM packages.

Expand All @@ -24,23 +24,23 @@ In short, javapackages-validator helps maintain Java packaging quality and consi
* During package reviews by distribution maintainers.

== Building
The project is built with Maven. JDK of version 23 is required. Simply run:
The project is built with Maven. JDK version 23 is required. Simply run:
[source, shell]
----
$ mvn install
----

== Usage
The tool is executed from command line using `java` command with the proper class path.
JVM of version 23 is required.
The tool is executed from the command line using the `java` command with the proper classpath.
JVM version 23 is required.

[subs = quotes]
----
Main [_optional flags_] <_main arguments_>... [-f _RPM files or directories to test_]...
----

[NOTE]
Due to the usage of the https://openjdk.org/jeps/454[Foreign Function & Memory API] feature, JVM arguments must include: +
Due to the use of the https://openjdk.org/jeps/454[Foreign Function & Memory API] feature, JVM arguments must include: +
`--enable-native-access ALL-UNNAMED`.

Optional flags::
Expand Down