Skip to content

Commit 289c1e2

Browse files
committed
Update README and CONTRIBUTING
1 parent c0052a4 commit 289c1e2

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,6 @@ opam install ocaml-lsp-server
3636
3737
# Any recent OCaml version works as a development compiler
3838
opam switch create 4.14.0 # can also create local switch with opam switch create . 4.14.0
39-
40-
# We use NodeJS to run our test suites and other utilities.
41-
npm install
4239
```
4340

4441
## Initialize submodules
@@ -50,6 +47,10 @@ git submodule init
5047
git submodule update
5148
```
5249

50+
## npm install
51+
52+
Run `npm install`. This will build the ninja binary and run an initial `./scripts/ninja.js config` and `./scripts/ninja.js build` (see below).
53+
5354
## Configure and Build the Compiler (`ninja` workflow)
5455

5556
> Note: These instructions allow you to do full builds of the project. In case you only want to build the project for development purposes, you can use the `dune` workflow, but you will still need to run the first step: `./scripts/ninja.js config`.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ ReScript is licensed under LGPL version 3, with relaxed rules about creating and
104104
`vendor/ocaml.tar.gz` contains the official [OCaml](https://ocaml.org) compiler (version 4.14.0).
105105
Refer to its copyright and license notices for information about its licensing.
106106

107-
The `ninja` submodule contains the vendored [ninja](https://github.com/ninja-build/ninja) build system.
107+
The `ninja` subdirectory contains the vendored [ninja](https://github.com/ninja-build/ninja) build system.
108108
Refer to its copyright and license notices for information about its licensing.
109109

110110
## 🏅 Acknowledgments

0 commit comments

Comments
 (0)