summary refs log tree commit diff
diff options
context:
space:
mode:
authorSander van der Burg <svanderburg@gmail.com>2016-09-17 22:49:27 +0200
committerGitHub <noreply@github.com>2016-09-17 22:49:27 +0200
commit8b597721f8fefd843307565627eee8312814f1d4 (patch)
tree003a1a7f9f243c00e441f90e919c13d3250700de
parentafa64a60bc73a5b5b1340f9ec9daae198d49e5d2 (diff)
parentcd343b76c7ed7405e97afd2cf5e699d5de657f4e (diff)
downloadnixpkgs-8b597721f8fefd843307565627eee8312814f1d4.tar
nixpkgs-8b597721f8fefd843307565627eee8312814f1d4.tar.gz
nixpkgs-8b597721f8fefd843307565627eee8312814f1d4.tar.bz2
nixpkgs-8b597721f8fefd843307565627eee8312814f1d4.tar.lz
nixpkgs-8b597721f8fefd843307565627eee8312814f1d4.tar.xz
nixpkgs-8b597721f8fefd843307565627eee8312814f1d4.tar.zst
nixpkgs-8b597721f8fefd843307565627eee8312814f1d4.zip
Merge pull request #18633 from siddharthist/doc/node-readme
nixpkgs docs: improve node packages documentation
-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!