| commit | 08b5ae52c1c7dc3587ad31eee3036b58c3df394d | [log] [tgz] |
|---|---|---|
| author | Joe Wilm <joe@jwilm.com> | Mon Jul 03 19:43:44 2017 -0700 |
| committer | Joe Wilm <joe@jwilm.com> | Mon Jul 03 19:45:21 2017 -0700 |
| tree | 44243738df269be71ced9971c31404d7b52baffb | |
| parent | 32dfddb91d30bd6d0e85512433da98c1bb036093 [diff] |
Revert "Reduce InstanceData footprint" This reverts commit 3cdba291242cc1c1684bff7f8242262b1cdeb582. On some systems, the target commit actually caused a massive performance issue rather than fixing one.
Alacritty is the fastest terminal emulator in existence. Using the GPU for rendering enables optimizations that simply aren't possible in other emulators. Alacritty currently supports macOS and Linux, and Windows support is planned before the 1.0 release.
Alacritty is focused on simplicity and performance. The performance goal means it should be faster than any other terminal emulator available. The simplicity goal means that it doesn't have features such as tabs or splits (which can be better provided by a window manager or terminal multiplexer) nor niceties like a GUI config editor.
The software is considered to be at an alpha level of readiness--there are missing features and bugs to be fixed, but it is already used by many as a daily driver.
Precompiled binaries will eventually be made available on supported platforms. This is minimally blocked on a stable config format. For now, Alacritty must be built from source.
Instructions are provided for macOS and many Linux variants to compile Alacritty from source. With the exception of Arch (which has a package in the AUR), please first read the prerequisites section, then find the section for your OS, and finally go to building and configuration.
git clone https://aur.archlinux.org/alacritty-git.git cd alacritty-git makepkg -isr
Install rustup.rs. DO NOT use the Homebrew Rust compiler on macOS (see FAQ for explanation).
Clone the source code:
git clone https://github.com/jwilm/alacritty.git cd alacritty
Make sure you have the right Rust compiler installed. Alacritty requires at least 1.15. Run
rustup override set stable rustup update stable
On Ubuntu, you need a few extra libraries to build Alacritty. Here's an apt command that should install all of them. If something is still found to be missing, please open an issue.
apt-get install cmake libfreetype6-dev libfontconfig1-dev xclip
On Arch Linux, you need a few extra libraries to build Alacritty. Here's a pacman command that should install all of them. If something is still found to be missing, please open an issue.
pacman -S cmake freetype2 fontconfig pkg-config make xclip
On Fedora, you need a few extra libraries to build Alacritty. Here's a dnf command that should install all of them. If something is still found to be missing, please open an issue.
dnf install cmake freetype-devel fontconfig-devel xclip
On openSUSE, you need a few extra libraries to build Alacritty. Here's a zypper command that should install all of them. If something is still found to be missing, please open an issue.
zypper install cmake freetype-devel fontconfig-devel xclip
Compiles out of the box for 14.2 For copy & paste support (middle mouse button) you need to install xclip https://slackbuilds.org/repository/14.2/misc/xclip/?search=xclip
On Void Linux, install following packages before compiling Alacritty:
xbps-install cmake freetype-devel freetype expat-devel fontconfig xclip
On FreeBSD, you need a few extra libraries to build Alacritty. Here's a pkg command that should install all of them. If something is still found to be missing, please open an issue.
pkg install cmake freetype2 fontconfig xclip pkgconf
On Solus, you need a few extra libraries to build Alacritty. Here's a eopkg command that should install all of them. If something is still found to be missing, please open an issue.
sudo eopkg install freetype2-devel fontconfig-devel
If you build Alacritty on another distribution, we would love some help filling in this section of the README.
Once all the prerequisites are installed, compiling Alacritty should be easy:
cargo build --release
If all goes well, this should place a binary at target/release/alacritty. BEFORE YOU RUN IT: Install the config file as described below; otherwise, many things (such as arrow keys) will not work. If you‘re on macOS, you’ll need to change the monospace font family to something like Menlo.
Many linux distributions support desktop entries for adding applications to system menus. To install the desktop entry for Alacritty, run
sudo cp target/release/alacritty /usr/local/bin # or anywhere else in $PATH cp Alacritty.desktop ~/.local/share/applications
Although it‘s possible the default configuration would work on your system, you’ll probably end up wanting to customize it anyhow. There is a default alacritty.yml at the git repository root. Alacritty looks for the configuration file as the following paths:
$XDG_CONFIG_HOME/alacritty/alacritty.yml$XDG_CONFIG_HOME/alacritty.yml$HOME/.config/alacritty/alacritty.yml$HOME/.alacritty.ymlIf neither of these paths are found then $XDG_CONFIG_HOME/alacritty/alacritty.yml is created once alacritty is first run. On most systems this often defaults to $HOME/.config/alacritty/alacritty.yml.
Many configuration options will take effect immediately upon saving changes to the config file. The only exception is the font, dimensions and dpi sections which requires Alacritty to be restarted. For further explanation of the config file, please consult the comments in the default config file.
If you run into a problem with Alacritty, please file an issue. If you‘ve got a feature request, feel free to ask about it. Keep in mind that Alacritty is very much not looking to be a feature-rich terminal emulator with all sorts of bells and widgets. It’s primarily a cross-platform, blazing fast tmux renderer that Just Works.
rustup.iTerm2 and Terminal.app. I've found that if tmux is running on another machine which is connected to Alacritty via SSH, this issue disappears. Actual throughput and rendering performance are still better in Alacritty.env WAYLAND_DISPLAY= alacrittyAlacritty discussion can be found in #alacritty on freenode.
Alacritty is released under the Apache License, Version 2.0.