Publish Github releases from Travis

This release introduces some config to automatically build deploy a
binaries on the github release page using travis. The build only happens
when a commit is tagged and it uses the stable version of rust.

The main travis sections (install/script/before_deploy) have been
moved out of the .travis.yml to make it easier to read, maintain and
extend the different steps of the CI process.

Since checking for the Rust version in CI is enough to know if clippy
should be used or not, the environment variable `CLIPPY` has also been
removed, which further allowed simplifying the CI process.

Besides the executables, some auxillary files are now also published as
part of a release when they have changed since the last tagged Alacritty
release. This should make it clear for returning users when a new
version of a specific auxillary file is required.

Instead of using the 14.04 image which travis provides by default, an
18.04 docker image is used to build the output binaries for Linux.
This affects both the .deb and the .tar.gz binary.

The advantage of this is that while binaries compiled on 14.04, do not
work on 18.04, it does work the other way around. The generated .tar.gz
binary has been tested on 18.04, Debian, Fedora and Archlinux and all
systems were able to run it without any warnings or errors.
7 files changed
tree: 445f7b37a73ab108c0503ca59621e3d54de42229
  1. .github/
  2. assets/
  3. ci/
  4. copypasta/
  5. docs/
  6. font/
  7. res/
  8. scripts/
  9. servo-freetype-proxy/
  10. snap/
  11. src/
  12. tests/
  13. winpty/
  14. .agignore
  15. .gitignore
  16. .travis.yml
  17. alacritty-completions.bash
  18. alacritty-completions.fish
  19. alacritty-completions.zsh
  20. alacritty.desktop
  21. alacritty.info
  22. alacritty.man
  23. alacritty.yml
  24. alacritty_macos.yml
  25. alacritty_windows.yml
  26. appveyor.yml
  27. build.rs
  28. Cargo.lock
  29. Cargo.toml
  30. CHANGELOG.md
  31. INSTALL.md
  32. LICENSE-APACHE
  33. Makefile
  34. README.md
README.md

Alacritty

Travis build Status Appveyor build Status

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.

About

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 are available for Windows through appveyor. Precompiled binaries for other platforms are minimally blocked on a stable config format. For now, Alacritty must be built from source.

Further information

Installation

Some operating systems already provide binaries for Alacritty, for everyone else the instructions to build Alacritty from source, can be found here.

Arch Linux

pacman -S alacritty

Debian/Ubuntu

Using cargo deb, you can create and install a deb file.

git clone https://github.com/jwilm/alacritty.git
cd alacritty
cargo install cargo-deb
cargo deb --install

openSUSE Tumbleweed Linux

zypper in alacritty

Void Linux

xbps-install alacritty

Gentoo Linux

emerge x11-terms/alacritty

FreeBSD

pkg install alacritty

Windows

Prebuilt binaries can be downloaded from the artifacts section of appveyor.

Configuration

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, alacritty_macos.yml, and alacritty_windows.yml at the git repository root. Alacritty looks for the configuration file as the following paths:

  1. $XDG_CONFIG_HOME/alacritty/alacritty.yml
  2. $XDG_CONFIG_HOME/alacritty.yml
  3. $HOME/.config/alacritty/alacritty.yml
  4. $HOME/.alacritty.yml

If none 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 and dimensions sections which requires Alacritty to be restarted. For further explanation of the config file, please consult the comments in the default config file.

Windows

On windows the config file is located at:

%UserProfile%\alacritty.yml

Issues (known, unknown, feature requests, etc)

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.

FAQ

Is it really the fastest terminal emulator?

In the terminals I‘ve benchmarked against, alacritty is either faster, WAY faster, or at least neutral. There are no benchmarks in which I’ve found Alacritty to be slower.

macOS + tmux + vim is slow! I thought this was supposed to be fast!

This appears to be an issue outside of terminal emulators; either macOS has an IPC performance issue, or either tmux or vim (or both) have a bug. This same issue can be seen in 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.

My arrow keys don't work.

It sounds like you deleted some key bindings from your config file. Please reference the default config file to restore them.

IRC

Alacritty discussion can be found in #alacritty on freenode.

Wayland

Wayland support is available, but not everything works as expected. Many people have found a better experience using XWayland which can be achieved launching Alacritty with the WAYLAND_DISPLAY environment variable cleared:

env WAYLAND_DISPLAY= alacritty

If you're interested in seeing our Wayland support improve, please head over to the Wayland meta issue on the winit project to see how you may contribute.

License

Alacritty is released under the Apache License, Version 2.0.