diff options
| author | Zac Pullar-Strecker <zacps@users.noreply.github.com> | 2019-02-03 01:00:29 +1300 |
|---|---|---|
| committer | Christian Duerr <chrisduerr@users.noreply.github.com> | 2019-02-02 12:00:29 +0000 |
| commit | 863d5581a6b9917a4000d59f449653eb1ddd6dee (patch) | |
| tree | 37b19ea1182b22613fcaec05a10499245e7d92c1 /README.md | |
| parent | 3562f2c9aacb4b7cba8a61d95f4d325b6b5887c1 (diff) | |
Document that alacritty requires winpty-agent on windows
To make things easier to understand for Windows users, the
relationship between Alacritty and the WinPTY agent has been
clarified in the documentation.
This also bundles the windows agent and exe together in a zip file to
make distribution for windows easier on the user.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 9 insertions, 2 deletions
@@ -91,7 +91,8 @@ eopkg install 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). ### Windows @@ -104,7 +105,13 @@ scoop install alacritty ### 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 |