1<p align="center">
2    <img width="200" alt="Alacritty Logo" src="https://raw.githubusercontent.com/alacritty/alacritty/master/extra/logo/compat/alacritty-term%2Bscanlines.png">
3</p>
4
5<h1 align="center">Alacritty - A fast, cross-platform, OpenGL terminal emulator</h1>
6
7<p align="center">
8  <img width="600"
9       alt="Alacritty - A fast, cross-platform, OpenGL terminal emulator"
10       src="https://user-images.githubusercontent.com/8886672/103264352-5ab0d500-49a2-11eb-8961-02f7da66c855.png">
11</p>
12
13## About
14
15Alacritty is a modern terminal emulator that comes with sensible defaults, but
16allows for extensive [configuration](#configuration). By integrating with other
17applications, rather than reimplementing their functionality, it manages to
18provide a flexible set of [features](./docs/features.md) with high performance.
19The supported platforms currently consist of BSD, Linux, macOS and Windows.
20
21The software is considered to be at a **beta** level of readiness; there are
22a few missing features and bugs to be fixed, but it is already used by many as
23a daily driver.
24
25Precompiled binaries are available from the [GitHub releases page](https://github.com/alacritty/alacritty/releases).
26
27## Features
28
29You can find an overview over the features available in Alacritty [here](./docs/features.md).
30
31## Further information
32
33- [Announcing Alacritty, a GPU-Accelerated Terminal Emulator](https://jwilm.io/blog/announcing-alacritty/) January 6, 2017
34- [A talk about Alacritty at the Rust Meetup January 2017](https://www.youtube.com/watch?v=qHOdYO3WUTk) January 19, 2017
35- [Alacritty Lands Scrollback, Publishes Benchmarks](https://jwilm.io/blog/alacritty-lands-scrollback/) September 17, 2018
36- [Version 0.3.0 Release Announcement](https://blog.christianduerr.com/alacritty_030_announcement) April 07, 2019
37- [Version 0.5.0 Release Announcement](https://blog.christianduerr.com/alacritty_0_5_0_announcement) July 31, 2020
38
39## Installation
40
41Alacritty can be installed by using various package managers on Linux, BSD,
42macOS and Windows.
43
44Prebuilt binaries for macOS and Windows can also be downloaded from the
45[GitHub releases page](https://github.com/alacritty/alacritty/releases).
46
47For everyone else, the detailed instructions to install Alacritty can be found
48[here](INSTALL.md).
49
50### Requirements
51
52- OpenGL 3.3 or higher
53- [Windows] ConPTY support (Windows 10 version 1809 or higher)
54
55## Configuration
56
57You can find the default configuration file with documentation for all available
58fields on the [GitHub releases page](https://github.com/alacritty/alacritty/releases) for each release.
59
60Alacritty doesn't create the config file for you, but it looks for one in the
61following locations:
62
631. `$XDG_CONFIG_HOME/alacritty/alacritty.yml`
642. `$XDG_CONFIG_HOME/alacritty.yml`
653. `$HOME/.config/alacritty/alacritty.yml`
664. `$HOME/.alacritty.yml`
67
68### Windows
69
70On Windows, the config file should be located at:
71
72`%APPDATA%\alacritty\alacritty.yml`
73
74## Contributing
75
76A guideline about contributing to Alacritty can be found in the
77[`CONTRIBUTING.md`](CONTRIBUTING.md) file.
78
79## FAQ
80
81**_Is it really the fastest terminal emulator?_**
82
83Benchmarking terminal emulators is complicated. Alacritty uses
84[vtebench](https://github.com/alacritty/vtebench) to quantify terminal emulator
85throughput and manages to consistently score better than the competition using
86it. If you have found an example where this is not the case, please report a
87bug.
88
89Other aspects like latency or framerate and frame consistency are more difficult
90to quantify. Some terminal emulators also intentionally slow down to save
91resources, which might be preferred by some users.
92
93If you have doubts about Alacritty's performance or usability, the best way to
94quantify terminal emulators is always to test them with **your** specific
95usecases.
96
97**_Why isn't feature X implemented?_**
98
99Alacritty has many great features, but not every feature from every other
100terminal. This could be for a number of reasons, but sometimes it's just not a
101good fit for Alacritty. This means you won't find things like tabs or splits
102(which are best left to a window manager or [terminal multiplexer][tmux]) nor
103niceties like a GUI config editor.
104
105## IRC
106
107Alacritty discussions can be found in `#alacritty` on Libera.Chat.
108
109## License
110
111Alacritty is released under the [Apache License, Version 2.0].
112
113[Apache License, Version 2.0]: https://github.com/alacritty/alacritty/blob/master/LICENSE-APACHE
114[tmux]: https://github.com/tmux/tmux
115