Skip to content
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.

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

Minor update to readme.adoc #235

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions jmolecules-apt/readme.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= jMolecules APT Processor

The jMolcules APT Processor verifies rules attached to jMolcules concepts during compilation without the need for any third-party tooling integration.
To activate the compiler extension include the following dependency in your project:
The jMolecules APT (Annotation Processing Tool) Processor verifies rules attached to jMolecules concepts during compilation, without the need for any third-party tooling integration.
To activate the compiler extension, include the following dependencies in your project:

[source, xml]
----
Expand All @@ -19,6 +19,6 @@ To activate the compiler extension include the following dependency in your proj

TIP: Use the https://github.com/xmolecules/jmolecules-bom?tab=readme-ov-file#jmolecules-bom[jMolecules BOM] to avoid having to explicitly declare dependency versions for each artifact individually.

Violations detected will immediately be displayed in your IDE on compilation or on your command line build execution.
Violations detected will be immediately displayed in your IDE upon compilation, or on your command line after build execution.

image::img/ide.png[]