vibeman 0.0.13 → 0.0.14

package/dist/node_modules/node-pty/README.md

@@ -0,0 +1,165 @@
+# node-pty
+
+[![Build Status](https://dev.azure.com/vscode/node-pty/_apis/build/status/Microsoft.node-pty?branchName=main)](https://dev.azure.com/vscode/node-pty/_build/latest?definitionId=11&branchName=main)
+
+`forkpty(3)` bindings for node.js. This allows you to fork processes with pseudoterminal file descriptors. It returns a terminal object which allows reads and writes.
+
+This is useful for:
+
+- Writing a terminal emulator (eg. via [xterm.js](https://github.com/sourcelair/xterm.js)).
+- Getting certain programs to *think* you're a terminal, such as when you need a program to send you control sequences.
+
+`node-pty` supports Linux, macOS and Windows. Windows support is possible by utilizing the [Windows conpty API](https://blogs.msdn.microsoft.com/commandline/2018/08/02/windows-command-line-introducing-the-windows-pseudo-console-conpty/) on Windows 1809+ and the [winpty](https://github.com/rprichard/winpty) library in older version.
+
+## API
+
+The full API for node-pty is contained within the [TypeScript declaration file](https://github.com/microsoft/node-pty/blob/main/typings/node-pty.d.ts), use the branch/tag picker in GitHub (`w`) to navigate to the correct version of the API.
+
+## Example Usage
+
+```js
+import * as os from 'node:os';
+import * as pty from 'node-pty';
+
+const shell = os.platform() === 'win32' ? 'powershell.exe' : 'bash';
+
+const ptyProcess = pty.spawn(shell, [], {
+  name: 'xterm-color',
+  cols: 80,
+  rows: 30,
+  cwd: process.env.HOME,
+  env: process.env
+});
+
+ptyProcess.onData((data) => {
+  process.stdout.write(data);
+});
+
+ptyProcess.write('ls\r');
+ptyProcess.resize(100, 40);
+ptyProcess.write('ls\r');
+```
+
+## Real-world Uses
+
+`node-pty` powers many different terminal emulators, including:
+
+- [Microsoft Visual Studio Code](https://code.visualstudio.com)
+- [Hyper](https://hyper.is/)
+- [Upterm](https://github.com/railsware/upterm)
+- [Script Runner](https://github.com/ioquatix/script-runner) for Atom.
+- [Theia](https://github.com/theia-ide/theia)
+- [FreeMAN](https://github.com/matthew-matvei/freeman) file manager
+- [terminus](https://atom.io/packages/terminus) - An Atom plugin for providing terminals inside your Atom workspace.
+- [x-terminal](https://atom.io/packages/x-terminal) - Also an Atom plugin that provides terminals inside your Atom workspace.
+- [Termination](https://atom.io/packages/termination) - Also an Atom plugin that provides terminals inside your Atom workspace.
+- [atom-xterm](https://atom.io/packages/atom-xterm) - Also an Atom plugin that provides terminals inside your Atom workspace.
+- [electerm](https://github.com/electerm/electerm) Terminal/SSH/SFTP client(Linux, macOS, Windows).
+- [Extraterm](http://extraterm.org/)
+- [Wetty](https://github.com/krishnasrinivas/wetty) Browser based Terminal over HTTP and HTTPS
+- [nomad](https://github.com/lukebarnard1/nomad-term)
+- [DockerStacks](https://github.com/sfx101/docker-stacks) Local LAMP/LEMP stack using Docker
+- [TeleType](https://github.com/akshaykmr/TeleType): cli tool that allows you to share your terminal online conveniently. Show off mad cli-fu, help a colleague, teach, or troubleshoot.
+- [mesos-term](https://github.com/criteo/mesos-term): A web terminal for Apache Mesos. It allows to execute commands within containers.
+- [Commas](https://github.com/CyanSalt/commas): A hackable terminal and command runner.
+- [ENiGMA½ BBS Software](https://github.com/NuSkooler/enigma-bbs): A modern BBS software with a nostalgic flair!
+- [Tinkerun](https://github.com/tinkerun/tinkerun): A new way of running Tinker.
+- [Tess](https://tessapp.dev): Hackable, simple and rapid terminal for the new era of technology 👍
+- [NxShell](https://nxshell.github.io/): An easy to use new terminal for Windows/Linux/MacOS platform.
+- [OpenSumi](https://github.com/opensumi/core): A framework helps you quickly build Cloud or Desktop IDE products.
+- [Enjoy Git](https://github.com/huangcs427/enjoy-git-release): A modern Git client featuring an intuitive user interface, built with Electron, Vue 3, and TypeScript.
+
+Do you use node-pty in your application as well? Please open a [Pull Request](https://github.com/Tyriar/node-pty/pulls) to include it here. We would love to have it in our list.
+
+## Building
+
+```bash
+# Install dependencies and build C++
+npm install
+# Compile TypeScript -> JavaScript
+npm run build
+```
+
+## Dependencies
+
+Node.JS 16 or Electron 19 is required to use `node-pty`. What version of node is supported is currently mostly bound to [whatever version Visual Studio Code is using](https://github.com/microsoft/node-pty/issues/557#issuecomment-1332193541).
+
+### Linux (apt)
+
+```sh
+sudo apt install -y make python build-essential
+```
+
+### macOS
+
+Xcode is needed to compile the sources, this can be installed from the App Store.
+
+### Windows
+
+`npm install` requires some tools to be present in the system like Python and C++ compiler. Windows users can easily install them by running the following command in PowerShell as administrator. For more information see https://github.com/felixrieseberg/windows-build-tools:
+
+```sh
+npm install --global --production windows-build-tools
+```
+
+The following are also needed:
+
+- [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk) - only the "Desktop C++ Apps" components are needed to be installed
+- Spectre-mitigated libraries - In order to avoid the build error "MSB8040: Spectre-mitigated libraries are required for this project", open the Visual Studio Installer, press the Modify button, navigate to the "Individual components" tab, search "Spectre", and install an option like "MSVC v143 - VS 2022 C++ x64/x86 Spectre-mitigated libs (Latest)" (the exact option to install will depend on your version of Visual Studio as well as your operating system architecture)
+
+## Debugging
+
+[The wiki](https://github.com/Microsoft/node-pty/wiki/Debugging) contains instructions for debugging node-pty.
+
+## Security
+
+All processes launched from node-pty will launch at the same permission level of the parent process. Take care particularly when using node-pty inside a server that's accessible on the internet. We recommend launching the pty inside a container to protect your host machine.
+
+## Thread Safety
+
+Note that node-pty is not thread safe so running it across multiple worker threads in node.js could cause issues.
+
+## Flow Control
+
+Automatic flow control can be enabled by either providing `handleFlowControl = true` in the constructor options or setting it later on:
+
+```js
+const PAUSE = '\x13';   // XOFF
+const RESUME = '\x11';  // XON
+
+const ptyProcess = pty.spawn(shell, [], {handleFlowControl: true});
+
+// flow control in action
+ptyProcess.write(PAUSE);  // pty will block and pause the child program
+...
+ptyProcess.write(RESUME); // pty will enter flow mode and resume the child program
+
+// temporarily disable/re-enable flow control
+ptyProcess.handleFlowControl = false;
+...
+ptyProcess.handleFlowControl = true;
+```
+
+By default `PAUSE` and `RESUME` are XON/XOFF control codes (as shown above). To avoid conflicts in environments that use these control codes for different purposes the messages can be customized as `flowControlPause: string` and `flowControlResume: string` in the constructor options. `PAUSE` and `RESUME` are not passed to the underlying pseudoterminal if flow control is enabled.
+
+## Troubleshooting
+
+### Powershell gives error 8009001d
+
+> Internal Windows PowerShell error.  Loading managed Windows PowerShell failed with error 8009001d.
+
+This happens when PowerShell is launched with no `SystemRoot` environment variable present.
+
+### ConnectNamedPipe failed: Windows error 232
+
+This error can occur due to anti-virus software intercepting winpty from creating a pty. To workaround this you can exclude this file from your anti-virus scanning `node-pty\build\Release\winpty-agent.exe`
+
+## pty.js
+
+This project is forked from [chjj/pty.js](https://github.com/chjj/pty.js) with the primary goals being to provide better support for later Node.js versions and Windows.
+
+## License
+
+Copyright (c) 2012-2015, Christopher Jeffrey (MIT License).<br>
+Copyright (c) 2016, Daniel Imms (MIT License).<br>
+Copyright (c) 2018, Microsoft Corporation (MIT License).

package/dist/node_modules/node-pty/binding.gyp

@@ -0,0 +1,111 @@
+{
+  'target_defaults': {
+    'dependencies': [
+      "<!(node -p \"require('node-addon-api').targets\"):node_addon_api_except",
+    ],
+    'conditions': [
+      ['OS=="win"', {
+        'msvs_configuration_attributes': {
+          'SpectreMitigation': 'Spectre'
+        },
+        'msvs_settings': {
+            'VCCLCompilerTool': {
+              'AdditionalOptions': [
+                '/guard:cf',
+                '/sdl',
+                '/W3',
+                '/w34244',
+                '/w34267',
+                '/ZH:SHA_256'
+              ]
+            },
+            'VCLinkerTool': {
+              'AdditionalOptions': [
+                '/DYNAMICBASE',
+                '/guard:cf'
+              ]
+            }
+          },
+      }],
+    ],
+  },
+  'conditions': [
+    ['OS=="win"', {
+      'targets': [
+        {
+          'target_name': 'conpty',
+          'sources' : [
+            'src/win/conpty.cc',
+            'src/win/path_util.cc'
+          ],
+          'libraries': [
+            '-lshlwapi'
+          ],
+        },
+        {
+          'target_name': 'conpty_console_list',
+          'sources' : [
+            'src/win/conpty_console_list.cc'
+          ],
+        },
+        {
+          'target_name': 'pty',
+          'include_dirs' : [
+            '<!(node -p "require(\'node-addon-api\').include_dir")',
+            'deps/winpty/src/include',
+          ],
+          # Disabled due to winpty
+          'msvs_disabled_warnings': [ 4506, 4530 ],
+          'dependencies' : [
+            'deps/winpty/src/winpty.gyp:winpty-agent',
+            'deps/winpty/src/winpty.gyp:winpty',
+          ],
+          'sources' : [
+            'src/win/winpty.cc',
+            'src/win/path_util.cc'
+          ],
+          'libraries': [
+            '-lshlwapi'
+          ],
+        }
+      ]
+    }, { # OS!="win"
+      'targets': [
+        {
+          'target_name': 'pty',
+          'sources': [
+            'src/unix/pty.cc',
+          ],
+          'libraries': [
+            '-lutil'
+          ],
+          'cflags': ['-Wall', '-O2', '-D_FORTIFY_SOURCE=2'],
+          'conditions': [
+            # http://www.gnu.org/software/gnulib/manual/html_node/forkpty.html
+            #   One some systems (at least including Cygwin, Interix,
+            #   OSF/1 4 and 5, and Mac OS X) linking with -lutil is not required.
+            ['OS=="mac" or OS=="solaris"', {
+              'libraries!': [
+                '-lutil'
+              ]
+            }]
+          ]
+        }
+      ]
+    }],
+    ['OS=="mac"', {
+      'targets': [
+        {
+          'target_name': 'spawn-helper',
+          'type': 'executable',
+          'sources': [
+            'src/unix/spawn-helper.cc',
+          ],
+          "xcode_settings": {
+            "MACOSX_DEPLOYMENT_TARGET":"10.7"
+          }
+        },
+      ]
+    }]
+  ]
+}

package/dist/node_modules/node-pty/deps/.editorconfig

@@ -0,0 +1,2 @@
+# Have editor config ignore this directory
+root = true

package/dist/node_modules/node-pty/deps/winpty/.drone.yml

@@ -0,0 +1,17 @@
+# Build configure for https://www.tea-ci.org (fork of Drone CI with Msys2 support)
+build:
+  image: teaci/msys$$arch
+  pull: true
+  shell: msys$$arch
+  commands:
+    - pacman -S --needed --noconfirm --noprogressbar mingw-w64-cross-gcc mingw-w64-cross-crt-git
+    - ./configure
+    - make
+    - make tests
+    - build/trivial_test.exe
+    - mintty --log - --exec build/winpty.exe cmd /c ver | grep Windows
+
+matrix:
+  arch:
+    - 64
+    - 32

package/dist/node_modules/node-pty/deps/winpty/.gitattributes

@@ -0,0 +1,19 @@
+*               text=auto
+*.bat           text eol=crlf
+*.c             text
+*.cc            text
+*.gyp           text
+*.gypi          text
+*.h             text
+*.ps1           text eol=crlf
+*.rst           text
+*.sh            text
+*.txt           text
+.gitignore      text
+.gitattributes  text
+Makefile        text
+configure       text
+
+*.sh            eol=lf
+configure       eol=lf
+VERSION.txt     eol=lf

package/dist/node_modules/node-pty/deps/winpty/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2011-2016 Ryan Prichard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

package/dist/node_modules/node-pty/deps/winpty/Makefile

@@ -0,0 +1,166 @@
+# Copyright (c) 2011-2015 Ryan Prichard
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+# Use make -n to see the actual command-lines make would run.
+
+# The default "make install" prefix is /usr/local.  Pass PREFIX=<path> on the
+# command-line to override the default.
+
+.SECONDEXPANSION :
+
+.PHONY : default
+default : all
+
+PREFIX := /usr/local
+UNIX_ADAPTER_EXE := winpty.exe
+MINGW_ENABLE_CXX11_FLAG := -std=c++11
+USE_PCH := 1
+
+COMMON_CXXFLAGS :=
+UNIX_CXXFLAGS :=
+MINGW_CXXFLAGS :=
+MINGW_LDFLAGS :=
+UNIX_LDFLAGS :=
+
+# Include config.mk but complain if it hasn't been created yet.
+ifeq "$(wildcard config.mk)" ""
+    $(error config.mk does not exist.  Please run ./configure)
+endif
+include config.mk
+
+COMMON_CXXFLAGS += \
+	-MMD -Wall \
+	-DUNICODE \
+	-D_UNICODE \
+	-D_WIN32_WINNT=0x0501 \
+	-Ibuild/gen
+
+UNIX_CXXFLAGS += \
+	$(COMMON_CXXFLAGS)
+
+MINGW_CXXFLAGS += \
+	$(COMMON_CXXFLAGS) \
+	-O2 \
+	$(MINGW_ENABLE_CXX11_FLAG)
+
+MINGW_LDFLAGS += -static -static-libgcc -static-libstdc++
+UNIX_LDFLAGS += $(UNIX_LDFLAGS_STATIC)
+
+ifeq "$(USE_PCH)" "1"
+MINGW_CXXFLAGS += -include build/mingw/PrecompiledHeader.h
+PCH_DEP := build/mingw/PrecompiledHeader.h.gch
+else
+PCH_DEP :=
+endif
+
+build/gen/GenVersion.h : VERSION.txt $(COMMIT_HASH_DEP) | $$(@D)/.mkdir
+	$(info Updating build/gen/GenVersion.h)
+	@echo "const char GenVersion_Version[] = \"$(shell cat VERSION.txt | tr -d '\r\n')\";" > build/gen/GenVersion.h
+	@echo "const char GenVersion_Commit[] = \"$(COMMIT_HASH)\";" >> build/gen/GenVersion.h
+
+build/mingw/PrecompiledHeader.h : src/shared/PrecompiledHeader.h | $$(@D)/.mkdir
+	$(info Copying $< to $@)
+	@cp $< $@
+
+build/mingw/PrecompiledHeader.h.gch : build/mingw/PrecompiledHeader.h | $$(@D)/.mkdir
+	$(info Compiling $<)
+	@$(MINGW_CXX) $(MINGW_CXXFLAGS) -c -o $@ $<
+
+-include build/mingw/PrecompiledHeader.h.d
+
+define def_unix_target
+build/$1/%.o : src/%.cc | $$$$(@D)/.mkdir
+	$$(info Compiling $$<)
+	@$$(UNIX_CXX) $$(UNIX_CXXFLAGS) $2 -I src/include -c -o $$@ $$<
+endef
+
+define def_mingw_target
+build/$1/%.o : src/%.cc $$(PCH_DEP) | $$$$(@D)/.mkdir
+	$$(info Compiling $$<)
+	@$$(MINGW_CXX) $$(MINGW_CXXFLAGS) $2 -I src/include -c -o $$@ $$<
+endef
+
+include src/subdir.mk
+
+.PHONY : all
+all : $(ALL_TARGETS)
+
+.PHONY : tests
+tests : $(TEST_PROGRAMS)
+
+.PHONY : install-bin
+install-bin : all
+	mkdir -p $(PREFIX)/bin
+	install -m 755 -p -s build/$(UNIX_ADAPTER_EXE) $(PREFIX)/bin
+	install -m 755 -p -s build/winpty.dll $(PREFIX)/bin
+	install -m 755 -p -s build/winpty-agent.exe $(PREFIX)/bin
+
+.PHONY : install-debugserver
+install-debugserver : all
+	mkdir -p $(PREFIX)/bin
+	install -m 755 -p -s build/winpty-debugserver.exe $(PREFIX)/bin
+
+.PHONY : install-lib
+install-lib : all
+	mkdir -p $(PREFIX)/lib
+	install -m 644 -p build/winpty.lib $(PREFIX)/lib
+
+.PHONY : install-doc
+install-doc :
+	mkdir -p $(PREFIX)/share/doc/winpty
+	install -m 644 -p LICENSE $(PREFIX)/share/doc/winpty
+	install -m 644 -p README.md $(PREFIX)/share/doc/winpty
+	install -m 644 -p RELEASES.md $(PREFIX)/share/doc/winpty
+
+.PHONY : install-include
+install-include :
+	mkdir -p $(PREFIX)/include/winpty
+	install -m 644 -p src/include/winpty.h $(PREFIX)/include/winpty
+	install -m 644 -p src/include/winpty_constants.h $(PREFIX)/include/winpty
+
+.PHONY : install
+install : \
+	install-bin \
+	install-debugserver \
+	install-lib \
+	install-doc \
+	install-include
+
+.PHONY : clean
+clean :
+	rm -fr build
+
+.PHONY : clean-msvc
+clean-msvc :
+	rm -fr src/Default src/Release src/.vs src/gen
+	rm -f src/*.vcxproj src/*.vcxproj.filters src/*.sln src/*.sdf
+
+.PHONY : distclean
+distclean : clean
+	rm -f config.mk
+
+.PRECIOUS : %.mkdir
+%.mkdir :
+	$(info Creating directory $(dir $@))
+	@mkdir -p $(dir $@)
+	@touch $@
+
+src/%.h :
+	@echo "Missing header file $@ (stale dependency file?)"

package/dist/node_modules/node-pty/deps/winpty/README.md

@@ -0,0 +1,151 @@
+# winpty
+
+[![Build Status](https://tea-ci.org/api/badges/rprichard/winpty/status.svg)](https://tea-ci.org/rprichard/winpty)
+
+winpty is a Windows software package providing an interface similar to a Unix
+pty-master for communicating with Windows console programs.  The package
+consists of a library (libwinpty) and a tool for Cygwin and MSYS for running
+Windows console programs in a Cygwin/MSYS pty.
+
+The software works by starting the `winpty-agent.exe` process with a new,
+hidden console window, which bridges between the console API and terminal
+input/output escape codes.  It polls the hidden console's screen buffer for
+changes and generates a corresponding stream of output.
+
+The Unix adapter allows running Windows console programs (e.g. CMD, PowerShell,
+IronPython, etc.) under `mintty` or Cygwin's `sshd` with
+properly-functioning input (e.g. arrow and function keys) and output (e.g. line
+buffering).  The library could be also useful for writing a non-Cygwin SSH
+server.
+
+## Supported Windows versions
+
+winpty runs on Windows XP through Windows 10, including server versions.  It
+can be compiled into either 32-bit or 64-bit binaries.
+
+## Cygwin/MSYS adapter (`winpty.exe`)
+
+### Prerequisites
+
+You need the following to build winpty:
+
+* A Cygwin or MSYS installation
+* GNU make
+* A MinGW g++ toolchain capable of compiling C++11 code to build `winpty.dll`
+  and `winpty-agent.exe`
+* A g++ toolchain targeting Cygwin or MSYS to build `winpty.exe`
+
+Winpty requires two g++ toolchains as it is split into two parts. The
+`winpty.dll` and `winpty-agent.exe` binaries interface with the native
+Windows command prompt window so they are compiled with the native MinGW
+toolchain.  The `winpty.exe` binary interfaces with the MSYS/Cygwin terminal so
+it is compiled with the MSYS/Cygwin toolchain.
+
+MinGW appears to be split into two distributions -- MinGW (creates 32-bit
+binaries) and MinGW-w64 (creates both 32-bit and 64-bit binaries).  Either
+one is generally acceptable.
+
+#### Cygwin packages
+
+The default g++ compiler for Cygwin targets Cygwin itself, but Cygwin also
+packages MinGW-w64 compilers.  As of this writing, the necessary packages are:
+
+* Either `mingw64-i686-gcc-g++` or `mingw64-x86_64-gcc-g++`.  Select the
+  appropriate compiler for your CPU architecture.
+* `gcc-g++`
+* `make`
+
+As of this writing (2016-01-23), only the MinGW-w64 compiler is acceptable.
+The MinGW compiler (e.g. from the `mingw-gcc-g++` package) is no longer
+maintained and is too buggy.
+
+#### MSYS packages
+
+For the original MSYS, use the `mingw-get` tool (MinGW Installation Manager),
+and select at least these components:
+
+* `mingw-developer-toolkit`
+* `mingw32-base`
+* `mingw32-gcc-g++`
+* `msys-base`
+* `msys-system-builder`
+
+When running `./configure`, make sure that `mingw32-g++` is in your
+`PATH`.  It will be in the `C:\MinGW\bin` directory.
+
+#### MSYS2 packages
+
+For MSYS2, use `pacman` and install at least these packages:
+
+* `msys/gcc`
+* `mingw32/mingw-w64-i686-gcc` or `mingw64/mingw-w64-x86_64-gcc`.  Select
+  the appropriate compiler for your CPU architecture.
+* `make`
+
+MSYS2 provides three start menu shortcuts for starting MSYS2:
+
+* MinGW-w64 Win32 Shell
+* MinGW-w64 Win64 Shell
+* MSYS2 Shell
+
+To build winpty, use the MinGW-w64 {Win32,Win64} shortcut of the architecture
+matching MSYS2.  These shortcuts will put the g++ compiler from the
+`{mingw32,mingw64}/mingw-w64-{i686,x86_64}-gcc` packages into the `PATH`.
+
+Alternatively, instead of installing `mingw32/mingw-w64-i686-gcc` or
+`mingw64/mingw-w64-x86_64-gcc`, install the `mingw-w64-cross-gcc` and
+`mingw-w64-cross-crt-git` packages.  These packages install cross-compilers
+into `/opt/bin`, and then any of the three shortcuts will work.
+
+### Building the Unix adapter
+
+In the project directory, run `./configure`, then `make`, then `make install`.
+By default, winpty is installed into `/usr/local`.  Pass `PREFIX=<path>` to
+`make install` to override this default.
+
+### Using the Unix adapter
+
+To run a Windows console program in `mintty` or Cygwin `sshd`, prepend
+`winpty` to the command-line:
+
+    $ winpty powershell
+    Windows PowerShell
+    Copyright (C) 2009 Microsoft Corporation. All rights reserved.
+
+    PS C:\rprichard\proj\winpty> 10 + 20
+    30
+    PS C:\rprichard\proj\winpty> exit
+
+## Embedding winpty / MSVC compilation
+
+See `src/include/winpty.h` for the prototypes of functions exported by
+`winpty.dll`.
+
+Only the `winpty.exe` binary uses Cygwin; all the other binaries work without
+it and can be compiled with either MinGW or MSVC.  To compile using MSVC,
+download gyp and run `gyp -I configurations.gypi` in the `src` subdirectory.
+This will generate a `winpty.sln` and associated project files.  See the
+`src/winpty.gyp` and `src/configurations.gypi` files for notes on dealing with
+MSVC versions and different architectures.
+
+Compiling winpty with MSVC currently requires MSVC 2013 or newer.
+
+## Debugging winpty
+
+winpty comes with a tool for collecting timestamped debugging output.  To use
+it:
+
+1. Run `winpty-debugserver.exe` on the same computer as winpty.
+2. Set the `WINPTY_DEBUG` environment variable to `trace` for the
+   `winpty.exe` process and/or the process using `libwinpty.dll`.
+
+winpty also recognizes a `WINPTY_SHOW_CONSOLE` environment variable.  Set it
+to 1 to prevent winpty from hiding the console window.
+
+## Copyright
+
+This project is distributed under the MIT license (see the `LICENSE` file in
+the project root).
+
+By submitting a pull request for this project, you agree to license your
+contribution under the MIT license to this project.