From 84c4cb976f64effb71ce35b0e4e5657c11c10d1d Mon Sep 17 00:00:00 2001 From: Geert Bevin Date: Tue, 4 Apr 2023 09:28:31 -0400 Subject: [PATCH] README --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5cc9d6f..2532e07 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,16 @@ [![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Java](https://img.shields.io/badge/java-17%2B-blue)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) [![Release](https://img.shields.io/github/release/rife2/bld-antrl4.svg)](https://github.com/rife2/bld-antlr4/releases/latest) -[![GitHub CI](https://github.com/rife2/bld-antrl4/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-antrl4/actions/workflows/bld.yml) +[![GitHub CI](https://github.com/rife2/bld-antlr4/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-antlr4/actions/workflows/bld.yml) -An extension for generating Java sources from ANTLR4 parsers. +A `bld` extension for generating Java sources from ANTLR4 parsers. -This is an example usage: +The complete document of `Antrl4Operation` can be found in its [javadocs](https://rife2.github.io/bld-antlr4/rife/bld/extension/Antlr4Operation.html). + +This is an example usage where your ANTLR4 sources would be located at +`src/main/antlr` and the parsers generated into `build/generated`. The `compile` +command then uses an adapted `CompileOperation` to include the generated +sources into the main source directories. ```java private final Antlr4Operation antlr4Operation_ = new Antlr4Operation(); @@ -29,6 +34,4 @@ throws Exception { .fromProject(this) .mainSourceDirectories(List.of(antlr4Operation_.outputDirectory()))); } -``` - -The complete document of `Antrl4Operation` can be found in its [javadocs](https://rife2.github.io/bld-antlr4/rife/bld/extension/Antlr4Operation.html). \ No newline at end of file +``` \ No newline at end of file