diff --git a/Readme.md b/Readme.md index c74a2203..e01307ab 100644 --- a/Readme.md +++ b/Readme.md @@ -1,13 +1,15 @@ - # Rescript Editor Support 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. The binary reads the `.cmt` and `.cmti` files and analyses them. -## Status +## Install -This is a preliminary version for early testing, the CLI is not stable yet. +``` +opam switch 4.06.1 +opam opam install . --deps-only +``` ## Build @@ -15,24 +17,15 @@ This is a preliminary version for early testing, the CLI is not stable yet. dune build ``` -## Usage - -### dump - -Compute jump-to-definition and hover information for `Foo.res` at line `0` and column `4`: +The built artifact is in `_build/install/default/bin/rescript-editor-support.exe` -``` -rescript-editor-support.exe dump src/Foo.res:0:4 -``` - -### complete +## Usage -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`. +Run: +```sh +_build/install/default/bin/rescript-editor-support.exe --help ``` -rescript-editor-support.exe complete src/Foo.res:0:4 Current.res -``` - ## History