2019-04-01 22:41:20 +00:00
|
|
|
<p align="center">
|
2021-01-09 17:05:25 +00:00
|
|
|
<img width="200" alt="Alacritty Logo" src="https://raw.githubusercontent.com/alacritty/alacritty/master/extra/logo/compat/alacritty-term%2Bscanlines.png">
|
2019-04-01 22:41:20 +00:00
|
|
|
</p>
|
2017-01-02 17:07:50 +00:00
|
|
|
|
2020-12-29 20:05:19 +00:00
|
|
|
<h1 align="center">Alacritty - A fast, cross-platform, OpenGL terminal emulator</h1>
|
2017-01-02 17:07:50 +00:00
|
|
|
|
|
|
|
<p align="center">
|
2019-02-18 19:54:46 +00:00
|
|
|
<img width="600"
|
2020-12-29 23:47:53 +00:00
|
|
|
alt="Alacritty - A fast, cross-platform, OpenGL terminal emulator"
|
2020-12-29 20:05:19 +00:00
|
|
|
src="https://user-images.githubusercontent.com/8886672/103264352-5ab0d500-49a2-11eb-8961-02f7da66c855.png">
|
2017-01-02 17:07:50 +00:00
|
|
|
</p>
|
|
|
|
|
|
|
|
## About
|
|
|
|
|
2020-12-29 20:05:19 +00:00
|
|
|
Alacritty is a modern terminal emulator that comes with sensible defaults, but
|
|
|
|
allows for extensive [configuration](#configuration). By integrating with other
|
|
|
|
applications, rather than reimplementing their functionality, it manages to
|
|
|
|
provide a flexible set of [features](./docs/features.md) with high performance.
|
|
|
|
The supported platforms currently consist of BSD, Linux, macOS and Windows.
|
2017-01-02 17:07:50 +00:00
|
|
|
|
2020-12-29 20:05:19 +00:00
|
|
|
The software is considered to be at a **beta** level of readiness; there are
|
2019-02-18 19:54:46 +00:00
|
|
|
a few missing features and bugs to be fixed, but it is already used by many as
|
|
|
|
a daily driver.
|
2017-06-27 15:59:18 +00:00
|
|
|
|
2020-01-11 01:23:13 +00:00
|
|
|
Precompiled binaries are available from the [GitHub releases page](https://github.com/alacritty/alacritty/releases).
|
2017-01-06 17:30:01 +00:00
|
|
|
|
2020-07-23 22:32:38 +00:00
|
|
|
## Features
|
|
|
|
|
|
|
|
You can find an overview over the features available in Alacritty [here](./docs/features.md).
|
|
|
|
|
2017-01-21 18:00:07 +00:00
|
|
|
## Further information
|
2017-01-04 17:17:56 +00:00
|
|
|
|
2018-11-07 20:04:41 +00:00
|
|
|
- [Announcing Alacritty, a GPU-Accelerated Terminal Emulator](https://jwilm.io/blog/announcing-alacritty/) January 6, 2017
|
2021-01-18 11:17:04 +00:00
|
|
|
- [A talk about Alacritty at the Rust Meetup January 2017](https://www.youtube.com/watch?v=qHOdYO3WUTk) January 19, 2017
|
2018-09-17 15:56:15 +00:00
|
|
|
- [Alacritty Lands Scrollback, Publishes Benchmarks](https://jwilm.io/blog/alacritty-lands-scrollback/) September 17, 2018
|
2017-01-04 17:17:56 +00:00
|
|
|
|
2017-06-27 15:59:18 +00:00
|
|
|
## Installation
|
|
|
|
|
2020-08-07 14:13:41 +00:00
|
|
|
Alacritty can be installed by using various package managers on Linux, BSD,
|
|
|
|
macOS and Windows.
|
2017-01-02 17:07:50 +00:00
|
|
|
|
2020-08-07 14:13:41 +00:00
|
|
|
Prebuilt binaries for macOS and Windows can also be downloaded from the
|
2020-07-24 16:29:00 +00:00
|
|
|
[GitHub releases page](https://github.com/alacritty/alacritty/releases).
|
2019-02-02 12:00:29 +00:00
|
|
|
|
2020-08-07 14:13:41 +00:00
|
|
|
For everyone else, the detailed instructions to install Alacritty can be found
|
|
|
|
[here](INSTALL.md).
|
|
|
|
|
2021-02-28 17:12:24 +00:00
|
|
|
### Requirements
|
|
|
|
|
2022-03-02 10:05:12 +00:00
|
|
|
- At least OpenGL ES 2.0
|
2021-02-28 17:12:24 +00:00
|
|
|
- [Windows] ConPTY support (Windows 10 version 1809 or higher)
|
2021-01-12 13:51:32 +00:00
|
|
|
|
2017-01-14 20:43:29 +00:00
|
|
|
## Configuration
|
2017-01-02 17:07:50 +00:00
|
|
|
|
2019-10-06 10:47:20 +00:00
|
|
|
You can find the default configuration file with documentation for all available
|
2020-01-11 01:23:13 +00:00
|
|
|
fields on the [GitHub releases page](https://github.com/alacritty/alacritty/releases) for each release.
|
2019-10-06 10:47:20 +00:00
|
|
|
|
2020-02-07 23:39:39 +00:00
|
|
|
Alacritty doesn't create the config file for you, but it looks for one in the
|
|
|
|
following locations:
|
2017-01-07 21:19:30 +00:00
|
|
|
|
|
|
|
1. `$XDG_CONFIG_HOME/alacritty/alacritty.yml`
|
2017-01-08 00:12:28 +00:00
|
|
|
2. `$XDG_CONFIG_HOME/alacritty.yml`
|
|
|
|
3. `$HOME/.config/alacritty/alacritty.yml`
|
2017-01-09 06:40:47 +00:00
|
|
|
4. `$HOME/.alacritty.yml`
|
2017-01-07 21:19:30 +00:00
|
|
|
|
2018-10-16 17:02:52 +00:00
|
|
|
### Windows
|
|
|
|
|
2020-02-07 23:39:39 +00:00
|
|
|
On Windows, the config file should be located at:
|
2018-10-16 17:02:52 +00:00
|
|
|
|
2018-12-28 15:26:58 +00:00
|
|
|
`%APPDATA%\alacritty\alacritty.yml`
|
2018-10-16 17:02:52 +00:00
|
|
|
|
2019-04-09 19:29:46 +00:00
|
|
|
## Contributing
|
|
|
|
|
2020-12-29 20:05:19 +00:00
|
|
|
A guideline about contributing to Alacritty can be found in the
|
2019-04-09 19:29:46 +00:00
|
|
|
[`CONTRIBUTING.md`](CONTRIBUTING.md) file.
|
|
|
|
|
2017-01-02 17:07:50 +00:00
|
|
|
## FAQ
|
|
|
|
|
2018-10-16 17:02:52 +00:00
|
|
|
**_Is it really the fastest terminal emulator?_**
|
2018-02-28 03:48:37 +00:00
|
|
|
|
2020-12-29 20:05:19 +00:00
|
|
|
Benchmarking terminal emulators is complicated. Alacritty uses
|
|
|
|
[vtebench](https://github.com/alacritty/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.
|
2019-02-18 19:54:46 +00:00
|
|
|
|
|
|
|
**_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][tmux]) nor
|
|
|
|
niceties like a GUI config editor.
|
2018-02-28 03:48:37 +00:00
|
|
|
|
2017-01-19 07:02:53 +00:00
|
|
|
## IRC
|
|
|
|
|
2021-06-19 13:29:30 +00:00
|
|
|
Alacritty discussions can be found in `#alacritty` on Libera.Chat.
|
2017-10-22 00:06:47 +00:00
|
|
|
|
2017-01-02 17:07:50 +00:00
|
|
|
## License
|
|
|
|
|
|
|
|
Alacritty is released under the [Apache License, Version 2.0].
|
|
|
|
|
2020-01-11 01:23:13 +00:00
|
|
|
[Apache License, Version 2.0]: https://github.com/alacritty/alacritty/blob/master/LICENSE-APACHE
|
2017-06-27 15:59:18 +00:00
|
|
|
[tmux]: https://github.com/tmux/tmux
|