Skip to content

Commit da6a06b

Browse files
committed
update README
1 parent 5c18e9e commit da6a06b

File tree

2 files changed

+8
-29
lines changed

2 files changed

+8
-29
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ package-lock.json
1717
build/
1818
*.dylib
1919
*.dylib.dSYM
20+
*.so
2021
*.so.dSYM

README.md

Lines changed: 7 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,11 @@
1-
# [WIP] tree-sitter-quint
1+
# Tree Sitter Quint
22

3-
Tree Sitter grammar for [Quint](https://quint-lang.org/).
4-
Mainly with the goal to get editor support into [Helix](https://helix-editor.com/).
3+
[Tree Sitter](https://tree-sitter.github.io/tree-sitter/)
4+
grammar for
5+
[Quint](https://quint-lang.org/).
6+
Mainly with the goal to get editor support into
7+
[Helix](https://helix-editor.com/).
58

6-
To avoid tracking build artifacts in Git,
9+
To avoid cluttering the repository with build artifacts,
710
the generated parser is not included on the `master` branch.
811
Check the `release` branch instead.
9-
10-
## Example Helix Config (for now):
11-
12-
```toml
13-
# languages.toml
14-
15-
[[language]]
16-
comment-token = "//"
17-
file-types = ["qnt"]
18-
language-servers = ["quint-lsp"]
19-
name = "quint"
20-
scope = "source.quint"
21-
block-comment-tokens = { start = "/*", end = "*/" }
22-
tab-width = 2
23-
unit = " "
24-
25-
[[grammar]]
26-
name = "quint"
27-
source = { git = "https://github.com/gruhn/tree-sitter-quint.git", rev = "release" }
28-
29-
[language-server.quint-lsp]
30-
args = ["--stdio"]
31-
command = "quint-language-server"
32-
```
33-
Also: download [helix-highlights.scm](https://github.com/gruhn/tree-sitter-quint/blob/release/queries/helix-highlights.scm) into your `<config-dir>/helix/runtime/queries/quint/highlights.scm`.

0 commit comments

Comments
 (0)