summary refs log tree commit diff
path: root/pkgs
diff options
context:
space:
mode:
authorLangston Barrett <langston.barrett@gmail.com>2016-09-15 17:54:22 +0000
committerLangston Barrett <langston.barrett@gmail.com>2016-09-15 18:15:53 +0000
commitcd343b76c7ed7405e97afd2cf5e699d5de657f4e (patch)
tree7c8b037ed88bf5dc4218b66955f499d1a5e48d4f /pkgs
parent51314631d6ee153dab70d99f7a08f04a89d23c5e (diff)
downloadnixpkgs-cd343b76c7ed7405e97afd2cf5e699d5de657f4e.tar
nixpkgs-cd343b76c7ed7405e97afd2cf5e699d5de657f4e.tar.gz
nixpkgs-cd343b76c7ed7405e97afd2cf5e699d5de657f4e.tar.bz2
nixpkgs-cd343b76c7ed7405e97afd2cf5e699d5de657f4e.tar.lz
nixpkgs-cd343b76c7ed7405e97afd2cf5e699d5de657f4e.tar.xz
nixpkgs-cd343b76c7ed7405e97afd2cf5e699d5de657f4e.tar.zst
nixpkgs-cd343b76c7ed7405e97afd2cf5e699d5de657f4e.zip
nixpkgs docs: improve node packages documentation
 * be more specific about paths to files
Diffstat (limited to 'pkgs')
-rw-r--r--pkgs/development/node-packages/README13
-rw-r--r--pkgs/development/node-packages/README.md11
2 files changed, 11 insertions, 13 deletions
diff --git a/pkgs/development/node-packages/README b/pkgs/development/node-packages/README
deleted file mode 100644
index 48354324a05..00000000000
--- a/pkgs/development/node-packages/README
+++ /dev/null
@@ -1,13 +0,0 @@
-How to update the NPM packages
-==============================
-- Install node2nix:
-
-nix-env -f '<nixpkgs>' -iA node2nix
-
-- Modify node-packages.json, add, update or remove package entries
-
-- Run the script:
-
-sh generate.sh
-
-- Done!
diff --git a/pkgs/development/node-packages/README.md b/pkgs/development/node-packages/README.md
new file mode 100644
index 00000000000..d1820e765b9
--- /dev/null
+++ b/pkgs/development/node-packages/README.md
@@ -0,0 +1,11 @@
+NPM packages
+===========
+ 1. Install node2nix: `nix-env -f '<nixpkgs>' -iA node2nix`.
+ 2. Modify `pkgs/development/node-packages/node-packages.json`, to add, update,
+    or remove package entries.
+ 3. Run the script: `cd pkgs/development/node-packages && sh generate.sh`.
+ 4. Build your new package to test your changes: `cd /path/to/nixpkgs &&
+   nix-build -A nodePackages.<new-or-updated-package>`. To build against a
+   specific node.js version (e.g. 5.x): `nix-build -A
+   nodePackages_5_x.<new-or-updated-package>`
+ 5. Add, commit, and share your changes!