Merge pull request #18633 from siddharthist/doc/node-readme

nixpkgs docs: improve node packages documentation
This commit is contained in:
Sander van der Burg 2016-09-17 22:49:27 +02:00 committed by GitHub
commit 8b597721f8
2 changed files with 11 additions and 13 deletions

View file

@ -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!

View file

@ -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!