diff options
author | Robert Kowalski <rok@kowalski.gd> | 2014-06-01 16:45:04 +0400 |
---|---|---|
committer | Robert Kowalski <rok@kowalski.gd> | 2014-06-01 16:45:04 +0400 |
commit | 5191b5c417181299f0b40f7e1889a6ba25d357e4 (patch) | |
tree | 89f05fa4c487b245026c6bc0a45afc6c78dddeed /doc | |
parent | c9b8c998b863755174ef7ffc85d02a63368eac13 (diff) |
docs: document common npm dependencies
Closes #5299
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cli/npm.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/cli/npm.md b/doc/cli/npm.md index 903aa1079..ad16d419e 100644 --- a/doc/cli/npm.md +++ b/doc/cli/npm.md @@ -31,6 +31,22 @@ Use `npm install blerg` to install the latest version of "blerg". Check out Use the `npm search` command to show everything that's available. Use `npm ls` to show everything you've installed. +## DEPENDENCIES + +If a package references to another package with a git URL, npm depends +on a preinstalled git. + +If one of the packages npm tries to install is a native node module and +requires compiling of C++ Code, npm will use +[node-gyp](https://github.com/TooTallNate/node-gyp) for that task. +For a Unix system, [node-gyp](https://github.com/TooTallNate/node-gyp) +needs Python, make and a buildchain like GCC. On Windows, +Python and Microsoft Visual Studio C++ is needed. Python 3 is +not supported by [node-gyp](https://github.com/TooTallNate/node-gyp). +For more information visit +[the node-gyp repository](https://github.com/TooTallNate/node-gyp) and +the [node-gyp Wiki](https://github.com/TooTallNate/node-gyp/wiki). + ## DIRECTORIES See `npm-folders(5)` to learn about where npm puts stuff. |