Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorForrest L Norvell <ogd@aoaioxxysz.net>2014-06-04 03:17:20 +0400
committerForrest L Norvell <ogd@aoaioxxysz.net>2014-06-04 03:17:20 +0400
commitacb63b4720b65dfcb39f67c6016921832a159ded (patch)
tree89f05fa4c487b245026c6bc0a45afc6c78dddeed
parentc9b8c998b863755174ef7ffc85d02a63368eac13 (diff)
parent5191b5c417181299f0b40f7e1889a6ba25d357e4 (diff)
Merge pull request #5390 from robertkowalski/docs-git-dep
docs: document common npm dependencies
-rw-r--r--doc/cli/npm.md16
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.