Update README
Explain the project structure and update the links.
-# TreeSitterKotlin
+# Tree-Sitter Kotlin Grammar
[Kotlin](https://kotlinlang.org) language grammar for [Tree-Sitter](http://tree-sitter.github.io/tree-sitter/).
![Icon](Icon128.png)
@@ -7,6 +7,14 @@ The grammar is based on the [official language grammar](https://kotlinlang.org/d
_Note that the grammar is highly experimental and not suited for production usage yet!_
+## Project Structure
+
+| File | Description |
+| ---- | ----------- |
+| grammar.js | The Tree-Sitter grammar |
+| grammar-reference.js | A direct translation of the Kotlin language grammar that is, however, ambiguous to Tree-Sitter |
+| src | The generated parser |
+
## Setup
First, make sure to have Node.js 8 installed. Then run
@@ -23,11 +31,18 @@ To re-compile the grammar, run:
Note that the grammar is written completely in JavaScript (`grammar.js`), the other source files are generated by `tree-sitter`.
+## Testing
+
+To run the unit tests, run:
+
+>`tree-sitter test`
+
+
## Documentation
More documentation on how to create Tree-Sitter grammars [can be found here](https://tree-sitter.github.io/tree-sitter/creating-parsers).
## See also
-* [KotlinLanguageServer](https://github.com/fwcd/KotlinLanguageServer) for code completion, diagnostics and more
-* [KotlinDebugAdapter](https://github.com/fwcd/KotlinDebugAdapter) for JVM debugging support
+* [Kotlin Language Server](https://github.com/fwcd/kotlin-language-server) for code completion, diagnostics and more
+* [Kotlin Debug Adapter](https://github.com/fwcd/kotlin-debug-adapter) for JVM debugging support
