Skip to content

Commit 1f7a113

Browse files
committed
Tweak installation messages
1 parent 88cf686 commit 1f7a113

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

src/pages/guide/editor-tools/global-installation.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ order: 10
1313
| **Linux** | `npm install -g https://github.com/reasonml/reason-cli/archive/beta-v-1.13.7-bin-linux.tar.gz`
1414
| **Windows** | Please see https://github.com/reasonml/reasonml.github.io/issues/195
1515

16-
**Extra note for Windows users**: the current editor tooling support for Windows is shaky. Please help us improve it through the issue above! Thank you.
17-
1816
### (Alternative) Through OPAM
1917

2018
[OPAM](https://opam.ocaml.org) is the native package manager for OCaml. If you come from OCaml and don't have npm/yarn, you can optionally install this way, but be careful!
@@ -40,20 +38,23 @@ Finally, if things still don't work, please file an issue at https://github.com/
4038

4139
#### Editor Plugin Not Working
4240

43-
Assuming the installation of the binaries succeeded, if your editor integration doesn't work, do the following:
41+
- **If you're on Windows**, the current editor tooling support for Windows is shaky. Please help us improve it in https://github.com/reasonml/reasonml.github.io/issues/195. Thank you!
4442

45-
```
46-
which ocamlmerlin refmt ocamlmerlin-reason
47-
```
43+
- Make sure you restart your editor. Some of them might not pick up your new shell environment (which now includes the newly installed binaries) without one.
4844

49-
It should spit out three paths that contain the word `reason-cli`. Note: during `npm/yarn` installation, the `node_modules/reason-cli` paths may be symlinked to `/usr/local/bin` (if so, the latter will display).
45+
- Try the following:
46+
```
47+
which ocamlmerlin refmt ocamlmerlin-reason
48+
```
49+
It should spit out three paths that contain the word `reason-cli` if the `reason-cli` installation succeeded.
5050

51-
```
52-
ocamlmerlin -version
53-
```
51+
- Check the Merlin version:
52+
```
53+
ocamlmerlin -version
54+
```
5455

55-
It should say "The Merlin toolkit version 2.5.x, for Ocaml 4.02.3". Not OCaml 4.03, not 4.04, etc.
56+
It should say "The Merlin toolkit version 2.5.x, for Ocaml 4.02.3". Not OCaml 4.03, not 4.04, etc.
5657

5758
#### Editor Error Message: Unbound Module `Js`, Etc.
5859

59-
If you're on Visual Studio Code, make sure you open the editor at the project's root (where `package.json` and `bsconfig.json` are). You can do so, for example, by incoking `code .` in the terminal at the root.
60+
If you're on Visual Studio Code, make sure you open the editor at the project's root (where `package.json` and `bsconfig.json` are). You can do so, for example, by invoking `code .` in the terminal at the root.

0 commit comments

Comments
 (0)