docs: update README.md

HaydenOrz · Jul 29, 2024 · 50c324e · 50c324e
1 parent 977302e
commit 50c324e
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # Create Antlr4
 Using interactive command line to quickly create an ANTLR4 project.
 
+>[!TIP]
+>ANTLR4 requires java to generate from a g4 file, so check your local java environment before you start creating a project. You can run `java --version` to do some simple checks.
 
 ## Create An ANTLR4 Project
 With NPM:
@@ -22,5 +24,5 @@ $ pnpm create antlr4
 ```
 
 ## Built-in Templates
-+ Antlr4ng + TypeScript (Recommended)
-+ Antlr4 + JavaScript
++ [Antlr4ng](https://github.com/mike-lischke/antlr4ng) + TypeScript (Recommended)
++ [Antlr4](https://github.com/antlr/antlr4/blob/dev/doc/javascript-target.md) + JavaScript