Skip to content
Browse files

docs for npm build

  • Loading branch information...
1 parent e9e7342 commit 909bf2fd7e5dc049a5986288471fdf8eb3e66d8e @isaacs isaacs committed Apr 25, 2010
Showing with 25 additions and 0 deletions.
  1. +25 −0 doc/build.md
View
25 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)

0 comments on commit 909bf2f

Please sign in to comment.
Something went wrong with that request. Please try again.