From 863d5581a6b9917a4000d59f449653eb1ddd6dee Mon Sep 17 00:00:00 2001 From: Zac Pullar-Strecker Date: Sun, 3 Feb 2019 01:00:29 +1300 Subject: 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. --- INSTALL.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'INSTALL.md') diff --git a/INSTALL.md b/INSTALL.md index 5f1dfbc2..4f6f5db3 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -166,7 +166,8 @@ nix-shell -A alacritty '' #### Windows -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). +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). #### Other @@ -175,7 +176,7 @@ filling in this section of the README. ## Building -### Linux +### Linux / Windows Once all the prerequisites are installed, compiling Alacritty should be easy: @@ -184,6 +185,7 @@ cargo build --release ``` If all goes well, this should place a binary at `target/release/alacritty`. +On Windows this directory should also contain the `winpty-agent.exe`. #### Desktop Entry @@ -226,7 +228,7 @@ To choose a default terminal app, use Debian's `update-alternatives`. ```sh update-alternatives --config x-terminal-emulator -``` +``` ## Manual Page -- cgit v1.2.3