Skip to content
This repository was archived by the owner on Apr 24, 2021. It is now read-only.

Commit 3f057b6

Browse files
committed
Update readme
1 parent 49fb0b0 commit 3f057b6

File tree

1 file changed

+10
-17
lines changed

1 file changed

+10
-17
lines changed

Readme.md

+10-17
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,31 @@
1-
21
# Rescript Editor Support
32

43
This is a private command line binary used by [rescript-vscode](https://github.com/rescript-lang/rescript-vscode) to power a few functionalities such as jump to definition, hover and autocomplete.
54

65
The binary reads the `.cmt` and `.cmti` files and analyses them.
76

8-
## Status
7+
## Install
98

10-
This is a preliminary version for early testing, the CLI is not stable yet.
9+
```
10+
opam switch 4.06.1
11+
opam opam install . --deps-only
12+
```
1113

1214
## Build
1315

1416
```
1517
dune build
1618
```
1719

18-
## Usage
19-
20-
### dump
21-
22-
Compute jump-to-definition and hover information for `Foo.res` at line `0` and column `4`:
20+
The built artifact is in `_build/install/default/bin/rescript-editor-support.exe`
2321

24-
```
25-
rescript-editor-support.exe dump src/Foo.res:0:4
26-
```
27-
28-
### complete
22+
## Usage
2923

30-
Compute autocomplete for `Foo.res` at line `0` and column `4`, where `Foo.res` is being edited and its current content in the editor is in file `Current.res`.
24+
Run:
3125

26+
```sh
27+
_build/install/default/bin/rescript-editor-support.exe --help
3228
```
33-
rescript-editor-support.exe complete src/Foo.res:0:4 Current.res
34-
```
35-
3629

3730
## History
3831

0 commit comments

Comments
 (0)