Skip to content

Commit 27e3d17

Browse files
authored
Merge pull request #248 from johnhaley81/update-contribution-docs
Update contributor docs to install dependencies when creating switch
2 parents 0358d7d + 268e3e1 commit 27e3d17

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ For now, the server can only be used through the standard file descriptors `stdi
5252

5353
For an example of usage of the server in a VSCode extension, see [here](https://github.com/ocamllabs/vscode-ocaml-platform/blob/master/src/Extension.ml).
5454

55-
5655
## Features
5756

5857
The server supports the following queries:
@@ -90,11 +89,11 @@ git clone --recursive [email protected]:ocaml/ocaml-lsp.git
9089
# if you already cloned, pull submodules
9190
git submodule update --init --recursive
9291

93-
# create local switch (or use global one)
94-
opam switch create . ocaml-base-compiler.4.09.1
92+
# create local switch (or use global one) and install dependencies
93+
opam switch create . ocaml-base-compiler.4.09.1 --with-test
9594

96-
# install dependencies
97-
opam install . --deps-only --with-test
95+
# don't forget to set your environment to use the local switch
96+
eval ($opam env)
9897

9998
# build
10099
make build
@@ -113,8 +112,8 @@ $ make test
113112

114113
Note that tests require [Node.js][] and [Yarn][] installed.
115114

116-
[Node.js]: https://nodejs.org/en/
117-
[Yarn]: https://yarnpkg.com/lang/en/
115+
[node.js]: https://nodejs.org/en/
116+
[yarn]: https://yarnpkg.com/lang/en/
118117

119118
## Relationship to Other Tools
120119

@@ -136,15 +135,15 @@ lsp protocol covers a wider scope than merlin.
136135
Note that the comparisons below make no claims of being objective and may be
137136
entirely out of date:
138137

139-
* [reason-language-server](https://github.com/jaredly/reason-language-server)
138+
- [reason-language-server](https://github.com/jaredly/reason-language-server)
140139
This server supports
141140
[bucklescript](https://github.com/BuckleScript/bucklescript) &
142141
[reason](https://github.com/facebook/reason). However, this project does not
143142
use merlin which means that it supports less versions of OCaml and offers less
144143
"smart" functionality - especially in the face of sources that do not yet
145144
compile.
146145

147-
* [ocaml-language-server](https://github.com/ocaml-lsp/ocaml-language-server)
146+
- [ocaml-language-server](https://github.com/ocaml-lsp/ocaml-language-server)
148147
This project is extremely similar in the functionality it provides because it
149148
also reuses merlin on the backend. The essential difference is that this
150149
project is written in typescript, while our server is in OCaml. We feel that

0 commit comments

Comments
 (0)