summaryrefslogtreecommitdiff
path: root/BUILDING.md
diff options
context:
space:
mode:
authorTim Ermilov <yamalight@gmail.com>2017-10-09 13:10:54 -0400
committerRefael Ackermann <refack@gmail.com>2017-10-12 10:45:05 -0400
commit641ba5ecfadce9bcb47e079c1618245ecf69e7d8 (patch)
tree3cd3eccefaf49ecb16b003067260af547a9b27de /BUILDING.md
parenta36aa049c857d87580548d096743f0acf28d231b (diff)
downloadandroid-node-v8-641ba5ecfadce9bcb47e079c1618245ecf69e7d8.tar.gz
android-node-v8-641ba5ecfadce9bcb47e079c1618245ecf69e7d8.tar.bz2
android-node-v8-641ba5ecfadce9bcb47e079c1618245ecf69e7d8.zip
doc: document windows shell support
explain that Git Bash and Cygwin require winpty to work correctly. Added info on Git Bash running winpty automatically when running node without .exe extension. PR-URL: https://github.com/nodejs/node/pull/16104 Fixes: https://github.com/nodejs/node/issues/14100 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Diffstat (limited to 'BUILDING.md')
-rw-r--r--BUILDING.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/BUILDING.md b/BUILDING.md
index e9a6a8faf9..118dacd735 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -59,6 +59,12 @@ note1 - The gcc4.8-libs package needs to be installed, because node
by Joyent. SmartOS images >= 16.4 are not supported because
GCC 4.8 runtime libraries are not available in their pkgsrc repository
+*Note*: On Windows, running Node.js in windows terminal emulators like `mintty`
+ requires the usage of [winpty](https://github.com/rprichard/winpty) for
+ Node's tty channels to work correctly (e.g. `winpty node.exe script.js`).
+ In "Git bash" if you call the node shell alias (`node` without the `.exe`
+ extension), `winpty` is used automatically.
+
### Supported toolchains
Depending on host platform, the selection of toolchains may vary.