Skip to content

Commit 02919d9

Browse files
committed
Update contributing
1 parent 4411429 commit 02919d9

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,11 @@ git clone --depth 1 https://github.com/rescript-lang/rescript-compiler.git
3232

3333
This will only consume less than 50MB.
3434

35-
## Install OCaml compiler + dependencies
35+
## Installation
36+
37+
### A. Manual installation
38+
39+
#### Install OCaml compiler + dependencies
3640

3741
The ReScript compiler compiles with any recent OCaml compiler. We are using `dune` as a build system for easy workflows and proper IDE support.
3842

@@ -51,10 +55,18 @@ opam install . --deps-only
5155
opam install ocaml-lsp-server
5256
```
5357

54-
## npm install
58+
#### npm install
5559

5660
Run `npm install --ignore-scripts`. This will install the npm dependencies required for the build scripts.
5761

62+
### B. Devcontainer
63+
64+
The repository additionally provides [development container](https://containers.dev/) definition that can be used with [VSCode's Remote Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) - use it to get stable development environment.
65+
66+
Run the `Dev Containers: Rebuild and Reopen in Container` action to get started.
67+
68+
You can also open this dev container with [GitHub Codespaces](https://github.com/features/codespaces/).
69+
5870
## Building the Compiler
5971

6072
The compiler binaries themselves can be built directly with dune as follows:

0 commit comments

Comments
 (0)