aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.md b/README.md
index 945099d2..56f34c5c 100644
--- a/README.md
+++ b/README.md
@@ -79,11 +79,18 @@ nix-env -iA nixos.alacritty
brew cask install alacritty
```
-Once the cask is installed, it is recommended to setup the [manual page](INSTALL.md#manual-page), [shell completions](INSTALL.md#shell-completions), and [terminfo definitions](INSTALL.md#terminfo).
+Once the cask is installed, it is recommended to setup the [manual page](INSTALL.md#manual-page),
+[shell completions](INSTALL.md#shell-completions), and [terminfo definitions](INSTALL.md#terminfo).
### Other
-Prebuilt binaries for Linux, macOS, and Windows can be downloaded from the [GitHub releases page](https://github.com/jwilm/alacritty/releases).
+Prebuilt binaries for Linux, macOS, and Windows can be downloaded from the
+[GitHub releases page](https://github.com/jwilm/alacritty/releases).
+
+To work properly on Windows, Alacritty requires winpty to emulate UNIX's PTY API.
+The agent is a single binary (`winpty-agent.exe`) which **must** be in the same
+directory as the Alacritty executable and is available through the
+[GitHub releases page](https://github.com/jwilm/alacritty/releases).
## Configuration