diff options
author | isaacs <i@izs.me> | 2010-04-26 03:32:01 +0400 |
---|---|---|
committer | isaacs <i@izs.me> | 2010-04-26 03:39:53 +0400 |
commit | 909bf2fd7e5dc049a5986288471fdf8eb3e66d8e (patch) | |
tree | 4915811d060ba644dffd1da9caf81523a9521653 /doc | |
parent | e9e734278b3451922086edd587bb9d7b68e5d2dc (diff) |
docs for npm build
Diffstat (limited to 'doc')
-rw-r--r-- | doc/build.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/build.md b/doc/build.md new file mode 100644 index 000000000..e4675610d --- /dev/null +++ b/doc/build.md @@ -0,0 +1,25 @@ +npm-build(1) -- Build a package +=============================== + +## SYNOPSIS + + npm build <package-folder> + +* <package-folder>: + A folder containing a `package.json` file in its root. + +## DESCRIPTION + +This command should almost never need to be run directly. It is an abstraction +of the functionality shared by both npm-install(1) and npm-link(1). + +This command creates the various interwoven links that ensure a package's contents +are available in the root appropriately, and that its dependencies are linked +appropriately. + +See also: + +* npm-install(1) +* npm-link(1) +* npm-scripts(1) +* npm-json(1) |