Skip to content

Commit c09e7aa

Browse files
committed
docs: Use npm scripts rather than make, mention npm v7 requirement
1 parent 2ded43e commit c09e7aa

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -74,21 +74,25 @@ Hacking on `fluent.js` is easy! To quickly get started clone the repo:
7474
$ git clone https://github.com/projectfluent/fluent.js.git
7575
$ cd fluent.js
7676

77-
You'll need at least Node.js 12 LTS. Older versions are not supported.
77+
You'll need at least **Node.js 12** and **npm v7**.
78+
Older versions are not supported.
7879

79-
Install the dependencies used by all packages:
80+
Install the dependencies used by all packages, which are managed as
81+
[npm workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces):
8082

8183
$ npm install
8284

83-
Build all packages at once:
85+
Build and test all packages at once:
8486

85-
$ make
87+
$ npm run dist
8688

8789
…which is equivalent to:
8890

89-
$ make lint
90-
$ make test
91-
$ make build
91+
$ npm run clean
92+
$ npm run build --workspaces
93+
$ npm run lint
94+
$ npm run test
95+
$ npm run docs --workspaces
9296

93-
You can also `cd` into a package's directory and issue the above `make`
94-
commands from there. Only this one package will be affected.
97+
Each package may also be built separately by running `npm run build` in
98+
its directory.

0 commit comments

Comments
 (0)