Skip to content

Commit a87ccb2

Browse files
committed
Updating README.md
1 parent 85b825d commit a87ccb2

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,32 @@
55
<img src="https://avatars.githubusercontent.com/u/20327314?s=200&v=4" alt="Logo" width="120" height="120">
66
</a>
77

8-
<h3 align="center">antlr4-c3</h3>
8+
<h3 align="center">ANTLR4-C3 Java</h3>
99

1010
<p align="center">
11-
The ANTLR4 Code Completion Core
11+
The ANTLR4 Code Completion Core, ported to Java
1212
<br />
1313
<br />
1414
<a href="https://github.com/Strumenta/antlr4-c3-java/issues">Report Bug</a>
1515
</p>
1616

17+
![License](https://img.shields.io/github/license/mike-lischke/antlr4-c3?style=for-the-badge&color=lightgreen)
18+
19+
20+
This is a port of the antlr4-c3 library to Java.
21+
22+
The original project is [antlr4-c3](https://github.com/mike-lischke/antlr4-c3/tree/main), created by Mike Lischke.
23+
The author has created the original code for ANTLR4 C3, which is a TypeScript library. The Java port got contributions from Nick Stephen, @kaidjohnson, @rovo98
24+
, and @vityaman .
25+
26+
We are just maintaining and publishing such port, with the [authorization](https://github.com/mike-lischke/antlr4-c3/issues/175) from the author.
27+
28+
## License
29+
30+
This port, as the original code, is available under the MIT license.
31+
32+
## How to use ANTLR4 C3 in Java
1733

18-
This is a port of the antlr4-c3 library to Java forked from another [project](https://github.com/mike-lischke/antlr4-c3/tree/main) and now being distributed
19-
and maintained by Strumenta with the [authorization](https://github.com/mike-lischke/antlr4-c3/issues/175) from the author.
2034

2135
Please see next an explanation of the library and some examples.
2236
```
@@ -28,6 +42,8 @@ The only changes with respect to the original typescript implementation are:
2842
- use of Java logging framework for debug messages
2943
- CandidatesCollection has a new field which returns information about encountered preferred rules
3044

45+
## Development
46+
3147
### Making a release
3248

3349
```

0 commit comments

Comments
 (0)