antlr / antlr/stringtemplate4

Help newbies with ANTLR dependencies

Open
#318 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
1k
Forks
234
PR merge metrics
No merged PRs in 30d

Description

Hello.

Would it be possible to help newbies get started more quickly by spelling out the ANTLR dependencies everywhere? For example, the [Using StringTemplate with Java](https://github.com/antlr/stringtemplate4/blob/master/doc/java.md#using-stringtemplate-with-java) page does say

> All you need to do is get the StringTemplate jar into your CLASSPATH as well as its dependent ANTLR jar.

which is good, but better would be to help newcomers understand what exactly "its dependent ANTLR jar" is (e.g., its Maven coordinates, or at least the version). Moreover, [the download page](https://www.stringtemplate.org/download.html) says

> To use maven, refer to group ID org.antlr and artifact ID ST4 in your pom.xml file:

```xml

org.antlr
ST4
4.3.4

```
but makes no mention of an ANTLR dependency. So far I haven't found anything that says which ANTLR version to use for which ST4 version. Through trial-and-error, ANTLR 3.5.3 seemed to work with ST4 4.3.4. Surprisingly, none of the ANTLR4 versions I tried seemed to work. All threw `ClassNotFoundException: org.antlr.runtime.Token`. I'll keep looking. Maybe it's spelled out somewhere.

Thanks!
David

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.