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 /INSTALL.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 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -166,7 +166,8 @@ nix-shell -A alacritty '<nixpkgs>' #### 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 |