1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-18 13:55:23 -05:00
A cross-platform, OpenGL terminal emulator.
Find a file
Christian Duerr edfcb81339
Run clippy on MSRV
Since not all suggested clippy lints by stable clippy are supported on
the MSRV of Alacritty, this commit moves the clippy checks to the MSRV.

Unfortunately this will mean that our lints might be significantly
behind, however it ensures our CI never blocks any code that should be
valid.

Developers themselves of course can still run the latest clippy to
follow the up to date recommendations.
2021-02-27 15:06:22 +00:00
.builds Run clippy on MSRV 2021-02-27 15:06:22 +00:00
.github Run clippy on MSRV 2021-02-27 15:06:22 +00:00
alacritty Fix hollow block cursor being drawn for hidden cursor 2021-02-26 20:36:38 +00:00
alacritty_config_derive Replace serde's derive with custom proc macro 2020-12-21 02:44:38 +00:00
alacritty_terminal Bump base64 to 0.13.0 2021-02-24 17:52:35 +00:00
docs Add sync update terminfo and docs 2021-02-24 18:20:47 +00:00
extra Add sync update terminfo and docs 2021-02-24 18:20:47 +00:00
scripts
.agignore
.editorconfig
.gitattributes
.gitignore
alacritty.yml Add vi/search line indicator 2021-01-01 05:19:03 +00:00
Cargo.lock Run clippy on MSRV 2021-02-27 15:06:22 +00:00
Cargo.toml Replace serde's derive with custom proc macro 2020-12-21 02:44:38 +00:00
CHANGELOG.md Run clippy on MSRV 2021-02-27 15:06:22 +00:00
CONTRIBUTING.md Bump development version to 0.8.0-dev 2021-01-04 09:55:13 +00:00
INSTALL.md Remove Windows WinPTY backend 2021-01-01 05:07:39 +00:00
LICENSE-APACHE
Makefile
README.md Fix dead Alacritty talk link in readme 2021-01-18 11:17:04 +00:00
rustfmt.toml

Alacritty Logo

Alacritty - A fast, cross-platform, OpenGL terminal emulator

Alacritty - A fast, cross-platform, OpenGL terminal emulator

About

Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance. The supported platforms currently consist of BSD, Linux, macOS and Windows.

The software is considered to be at a beta level of readiness; there are a few missing features and bugs to be fixed, but it is already used by many as a daily driver.

Precompiled binaries are available from the GitHub releases page.

Features

You can find an overview over the features available in Alacritty here.

Further information

Installation

Alacritty can be installed by using various package managers on Linux, BSD, macOS and Windows.

Prebuilt binaries for macOS and Windows can also be downloaded from the GitHub releases page.

For everyone else, the detailed instructions to install Alacritty can be found here.

Since Alacritty uses OpenGL to render the terminal content on all platforms, it is currently not possible to run it without support for at least OpenGL 3.3.

Configuration

You can find the default configuration file with documentation for all available fields on the GitHub releases page for each release.

Alacritty doesn't create the config file for you, but it looks for one in the following locations:

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

Windows

On Windows, the config file should be located at:

%APPDATA%\alacritty\alacritty.yml

Contributing

A guideline about contributing to Alacritty can be found in the CONTRIBUTING.md file.

FAQ

Is it really the fastest terminal emulator?

Benchmarking terminal emulators is complicated. Alacritty uses vtebench to quantify terminal emulator throughput and manages to consistently score better than the competition using it. If you have found an example where this is not the case, please report a bug.

Other aspects like latency or framerate and frame consistency are more difficult to quantify. Some terminal emulators also intentionally slow down to save resources, which might be preferred by some users.

If you have doubts about Alacritty's performance or usability, the best way to quantify terminal emulators is always to test them with your specific usecases.

Why isn't feature X implemented?

Alacritty has many great features, but not every feature from every other terminal. This could be for a number of reasons, but sometimes it's just not a good fit for Alacritty. This means you won't find things like tabs or splits (which are best left to a window manager or terminal multiplexer) nor niceties like a GUI config editor.

IRC

Alacritty discussions can be found in #alacritty on freenode.

License

Alacritty is released under the Apache License, Version 2.0.