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: nodejs/node#16104 Fixes: nodejs/node#14100 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
ayojs · Oct 15, 2017 · 3fc9756 · 3fc9756
1 parent 57b6a16
commit 3fc9756
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/BUILDING.md b/BUILDING.md
@@ -59,6 +59,12 @@ note1 - The gcc4.8-libs package needs to be installed, because ayo
   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.