aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZac Pullar-Strecker <zacps@users.noreply.github.com>2018-11-24 19:00:57 +1300
committerGitHub <noreply@github.com>2018-11-24 19:00:57 +1300
commit77a10514ea2e5c1c42303b43d886a76c50ad065d (patch)
tree09401dd5367b95ce06f96c0226325fbddc7161bc
parent0d47cd25b90deecc2dbf40c8361d2310049fdde7 (diff)
downloadalacritty-77a10514ea2e5c1c42303b43d886a76c50ad065d.tar.gz
alacritty-77a10514ea2e5c1c42303b43d886a76c50ad065d.zip
Document that alacritty requires winpty-agent on windows
-rw-r--r--INSTALL.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md
index fff56906..d4c0fee9 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -168,6 +168,10 @@ nix-shell -A alacritty '<nixpkgs>'
On windows you will need to have the `{architecture}-pc-windows-msvc` toolchain installed as well as [Clang 3.9 or greater](http://releases.llvm.org/download.html).
+Alacritty requires winpty on windows to emulate UNIX's PTY API.
+The agent is a single binary (`winpty-agent.exe`) which MUST be in the same directory as `alacritty.exe`.
+It's included in binary releases and fetched by `build.rs` when compiled from source.
+
#### Other
If you build Alacritty on another distribution, we would love some help