Skip to content

Commit 2fae39d

Browse files
authored
Update README.md
1 parent eaaf337 commit 2fae39d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# antlr4nim
2-
Nim interface to ANTLR4 listener/visitor via jsffi.
2+
Nim interface to ANTLR4 listener/visitor via jsffi.
3+
4+
Current version supports interpreter generation - compiler functionality is in the pipeline.
35

46
[API](https://jan0sc.github.io/antlr4nim.html)
57

@@ -17,7 +19,7 @@ You know that the [ANTLR4](https://www.antlr.org/) parser generator makes it pos
1719
You also know that [Nim](https://nim-lang.org/) is an expressive general-purpose language that
1820

1921
* compiles to efficient C, C++ or JavaScript code.
20-
* has powerful metaprogramming tools that will make it much easier to write a compiler for your new language.
22+
* has powerful metaprogramming tools that should *(see FAQ below)* make it much easier to write a compiler for your new language.
2123

2224
You want to use both together? Of course you do. But ANTLR4 has no Nim target :(
2325

@@ -521,9 +523,9 @@ Here's some further reading that might help:
521523
Probably, but... you will need to make a big bundle of JS including the ANTLR4 runtime - the ANTLR team suggest to use [webpack](https://webpack.js.org/). I haven't attempted this yet. Suggestions welcome.
522524

523525
### What about compilation?
524-
The ultimate goal for this project is to produce a simple platform for compiler production based on an ANTLR4 grammar.
526+
The ultimate goal for this project is to create a simple platform for compiler production based on any ANTLR4 grammar.
525527

526-
At the moment antlr4nim can be used to make JS-hosted interpreters, but all the nice AST manipulations that Nim provides remain off-limits because they can't be used at runtime. I am working on an update that will cleanly separate the parse tree generation from traversal, so that compilation to any Nim target will be possible... soon.
528+
At the moment antlr4nim can be used to make JS-hosted interpreters, but all the nice AST tools that Nim provides remain off-limits because they can't be used at runtime. I am working on an update that will cleanly separate the parse tree generation from traversal, so that compilation to any Nim target will be possible... soon.
527529

528530

529531
## Credits

0 commit comments

Comments
 (0)