Skip to content

Commit 4d6329d

Browse files
nstepienAwk34
authored andcommitted
docs(readme): Add a more explicit advice for compiling native add-ons (#2282)
The node-gyp prerequisite was not making it clear that it is related to the npm install part of the Usage guide.
1 parent 94eace3 commit 4d6329d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

readme.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ Install `yo`, `gulp-cli`, and `generator-angular-fullstack`:
2323
```
2424
npm install -g yo gulp-cli generator-angular-fullstack
2525
```
26+
__Please note__: If you run into trouble compiling native add-ons during the installation, follow [`node-gyp`](https://github.com/nodejs/node-gyp)'s short guide on [required compilation tools](https://github.com/nodejs/node-gyp#installation).
27+
28+
---
2629

2730
Run `yo angular-fullstack`
2831
```
@@ -35,7 +38,6 @@ yo angular-fullstack
3538

3639
* MongoDB - Download and Install [MongoDB](https://www.mongodb.com/download-center#community) - If you plan on scaffolding your project with mongoose, you'll need mongoDB to be installed and have the `mongod` process running.
3740
* The project's JavaScript is written in ECMAScript 2015. If you're unfamiliar with the latest changes to the specification for JavaScript, check out http://es6-features.org/
38-
* [`node-gyp`](https://github.com/nodejs/node-gyp) - You'll likely need to be able to use `node-gyp`, Node's tool for compiling native add-ons (for things like database drivers). See its [Installation section](https://github.com/nodejs/node-gyp#installation) for more instructions.
3941

4042
## Supported Configurations
4143

0 commit comments

Comments
 (0)