doc: blorb about setting npm_config_OPTION_NAME

PR-URL: #1185 Fixes: #1180 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
nodejs · May 14, 2017 · c307b30 · c307b30
1 parent ce815f9
commit c307b30
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -192,6 +192,23 @@ Command Options
 | `--solution=$solution`            | Set Visual Studio Solution version (win)
 
 
+Configuration
+--------
+
+__`node-gyp` responds to environment variables or `npm` configuration__
+1. Environment variables take the form `npm_config_OPTION_NAME` for any of the 
+ options listed above (dashes in option names should be replaced by underscores).
+ These work also when `node-gyp` is invoked directly:  
+ `$ export npm_config_devdir=/tmp/.gyp`  
+ or on Windows  
+ `> set npm_config_devdir=c:\temp\.gyp`  
+2. As `npm` configuration, variables take the form `OPTION_NAME`.
+ This way only works when `node-gyp` is executed by `npm`:  
+ `$ npm config set [--global] devdir /tmp/.gyp`  
+ `$ npm i buffertools`
+
+
+
 License
 -------