summary refs log tree commit diff
path: root/pkgs/development/node-packages/README.md
diff options
context:
space:
mode:
authorGraham Christensen <graham@grahamc.com>2018-03-24 10:47:41 -0400
committerGraham Christensen <graham@grahamc.com>2018-03-25 19:52:00 -0400
commit92d53362d4da7e19b6a7a6b1b936a0a34a17c0c9 (patch)
tree0181e4b13913552df774069766369a5f75babbef /pkgs/development/node-packages/README.md
parenta0c525bd0a93fba70471392b8651882b52197788 (diff)
downloadnixlib-92d53362d4da7e19b6a7a6b1b936a0a34a17c0c9.tar
nixlib-92d53362d4da7e19b6a7a6b1b936a0a34a17c0c9.tar.gz
nixlib-92d53362d4da7e19b6a7a6b1b936a0a34a17c0c9.tar.bz2
nixlib-92d53362d4da7e19b6a7a6b1b936a0a34a17c0c9.tar.lz
nixlib-92d53362d4da7e19b6a7a6b1b936a0a34a17c0c9.tar.xz
nixlib-92d53362d4da7e19b6a7a6b1b936a0a34a17c0c9.tar.zst
nixlib-92d53362d4da7e19b6a7a6b1b936a0a34a17c0c9.zip
Move all nixpkgs doc files in to the doc directory
This makes a makefile-driven developer workflow nicer.
Diffstat (limited to 'pkgs/development/node-packages/README.md')
-rw-r--r--pkgs/development/node-packages/README.md52
1 files changed, 1 insertions, 51 deletions
diff --git a/pkgs/development/node-packages/README.md b/pkgs/development/node-packages/README.md
index 17a203ed12be..9760285a915e 100644
--- a/pkgs/development/node-packages/README.md
+++ b/pkgs/development/node-packages/README.md
@@ -1,51 +1 @@
-Node.js packages
-================
-The `pkgs/development/node-packages` folder contains a generated collection of
-[NPM packages](https://npmjs.com/) that can be installed with the Nix package
-manager.
-
-As a rule of thumb, the package set should only provide *end user* software
-packages, such as command-line utilities. Libraries should only be added to the
-package set if there is a non-NPM package that requires it.
-
-When it is desired to use NPM libraries in a development project, use the
-`node2nix` generator directly on the `package.json` configuration file of the
-project.
-
-The package set also provides support for multiple Node.js versions. The policy
-is that a new package should be added to the collection for the latest stable LTS
-release (which is currently 6.x), unless there is an explicit reason to support
-a different release.
-
-If your package uses native addons, you need to examine what kind of native
-build system it uses. Here are some examples:
-
-* `node-gyp`
-* `node-gyp-builder`
-* `node-pre-gyp`
-
-After you have identified the correct system, you need to override your package
-expression while adding in build system as a build input. For example, `dat`
-requires `node-gyp-build`, so we override its expression in `default-v6.nix`:
-
-```nix
-dat = nodePackages.dat.override (oldAttrs: {
-  buildInputs = oldAttrs.buildInputs ++ [ nodePackages.node-gyp-build ];
-});
-```
-
-To add a package from NPM to nixpkgs:
-
- 1. Modify `pkgs/development/node-packages/node-packages-v6.json` to add, update
-    or remove package entries. (Or `pkgs/development/node-packages/node-packages-v4.json`
-    for packages depending on Node.js 4.x)
- 2. Run the script: `(cd pkgs/development/node-packages && ./generate.sh)`.
- 3. 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. 4.x):
-    `nix-build -A nodePackages_4_x.<new-or-updated-package>`
- 4. Add and commit all modified and generated files.
-
-For more information about the generation process, consult the
-[README.md](https://github.com/svanderburg/node2nix) file of the `node2nix`
-tool.
+Moved to [/doc/languages-frameworks/node.section.md](/doc/languages-frameworks/node.section.md)