Skip to content

Commit de7cb69

Browse files
mizdebskmkoncek
authored andcommitted
Fix grammar and improve phrasing in README.adoc
1 parent 357c597 commit de7cb69

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ In short, javapackages-validator helps maintain Java packaging quality and consi
1212

1313
== Key features and purpose
1414

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

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

1919
* 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.
2020

21-
== When is it used?
21+
== When it is used
2222

2323
* By Java package maintainers or developers preparing RPM packages.
2424

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

2929
== Building
30-
The project is built with Maven. JDK of version 23 is required. Simply run:
30+
The project is built with Maven. JDK version 23 is required. Simply run:
3131
[source, shell]
3232
----
3333
$ mvn install
3434
----
3535

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

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

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

4949
Optional flags::

0 commit comments

Comments
 (0)