PolytreeDE/alacritty
1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-18 13:55:23 -05:00
Code Releases Activity
alacritty/README.md

116 lines
4.2 KiB
Markdown
Raw Permalink Normal View History

Add official logo
2019-04-01 18:41:20 -04:00
<p align="center">
Fix readme logo icon URL
2021-01-09 12:05:25 -05:00
<img width="200" alt="Alacritty Logo" src="https://raw.githubusercontent.com/alacritty/alacritty/master/extra/logo/compat/alacritty-term%2Bscanlines.png">
Add official logo
2019-04-01 18:41:20 -04:00
</p>
Write README.md
2017-01-02 12:07:50 -05:00
Update Alacritty's description Alacritty's description in the readme and manpage has always been a bit overly aggressive in its marketing. This new updated text should more accurately describe Alacritty's current state without pointlessly agitating people.
2020-12-29 15:05:19 -05:00
<h1 align="center">Alacritty - A fast, cross-platform, OpenGL terminal emulator</h1>
Write README.md
2017-01-02 12:07:50 -05:00
<p align="center">
Change the default colorscheme The new colorscheme is base16 classic dark with the bright colors generated with oklab toolkits. The base16 classic dark is less washed out and represents the current maintainers preference. The motivation to change it was subjective, though it does look like generic dark theme. On a side note, this colorscheme was used for alacritty.org web page for a long time, however it used different foreground color.
2023-06-29 15:08:18 -04:00
<img alt="Alacritty - A fast, cross-platform, OpenGL terminal emulator"
src="extra/promo/alacritty-readme.png">
Write README.md
2017-01-02 12:07:50 -05:00
</p>
## About
Update Alacritty's description Alacritty's description in the readme and manpage has always been a bit overly aggressive in its marketing. This new updated text should more accurately describe Alacritty's current state without pointlessly agitating people.
2020-12-29 15:05:19 -05: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.
Write README.md
2017-01-02 12:07:50 -05:00
Update Alacritty's description Alacritty's description in the readme and manpage has always been a bit overly aggressive in its marketing. This new updated text should more accurately describe Alacritty's current state without pointlessly agitating people.
2020-12-29 15:05:19 -05:00
The software is considered to be at a **beta** level of readiness; there are
Small Updates to the README (#2091) Update the README and related files. This commit generally updates some language in the "About" section, and other sections with respect to keeping accurate information, and laying out the project goals in a clear way. We're also marking Alacritty as "beta" software at this point, not that this has any explicit meaning.
2019-02-18 14:54:46 -05:00
a few missing features and bugs to be fixed, but it is already used by many as
a daily driver.
Update README Closes #636 Closes #592
2017-06-27 11:59:18 -04:00
Move Alacritty to organization This fixes various outdated links pointing to the old jwilm/alacritty repository. Since `copypasta` now has its own github repository at https://github.com/alacritty/copypasta, the sources have been removed from Alacritty.
2020-01-10 20:23:13 -05:00
Precompiled binaries are available from the [GitHub releases page](https://github.com/alacritty/alacritty/releases).
Add note about this release being pre-alpha
2017-01-06 12:30:01 -05:00
Change the way we refer to IRC chat
2023-06-13 00:54:17 -04:00
Join [`#alacritty`] on libera.chat if you have questions or looking for a quick help.
[`#alacritty`]: https://web.libera.chat/gamja/?channels=#alacritty
Document Alacritty's features
2020-07-23 18:32:38 -04:00
## Features
You can find an overview over the features available in Alacritty [here](./docs/features.md).
Mention talk at Rust Meetup in README.md
2017-01-21 13:00:07 -05:00
## Further information
Add note about forthcoming blog post
2017-01-04 12:17:56 -05:00
Fix grammatical errors in README
2018-11-07 15:04:41 -05:00
- [Announcing Alacritty, a GPU-Accelerated Terminal Emulator](https://jwilm.io/blog/announcing-alacritty/) January 6, 2017
Fix dead Alacritty talk link in readme
2021-01-18 06:17:04 -05:00
- [A talk about Alacritty at the Rust Meetup January 2017](https://www.youtube.com/watch?v=qHOdYO3WUTk) January 19, 2017
Add latest blog post to README
2018-09-17 11:56:15 -04:00
- [Alacritty Lands Scrollback, Publishes Benchmarks](https://jwilm.io/blog/alacritty-lands-scrollback/) September 17, 2018
Add note about forthcoming blog post
2017-01-04 12:17:56 -05:00
Update README Closes #636 Closes #592
2017-06-27 11:59:18 -04:00
## Installation
Rework installation instructions Since users should be capable of finding packages for their distributions, this removes all instructions that point users directly at specific packages. The third party repositories like COPR have been kept, since those are more difficult to find. The structure of the installation instructions has also been reworked to adjust for this and the post build instructions should be a bit cleaner now. Co-authored-by: Christian Duerr <contact@christianduerr.com>
2020-08-07 10:13:41 -04:00
Alacritty can be installed by using various package managers on Linux, BSD,
macOS and Windows.
Write README.md
2017-01-02 12:07:50 -05:00
Rework installation instructions Since users should be capable of finding packages for their distributions, this removes all instructions that point users directly at specific packages. The third party repositories like COPR have been kept, since those are more difficult to find. The structure of the installation instructions has also been reworked to adjust for this and the post build instructions should be a bit cleaner now. Co-authored-by: Christian Duerr <contact@christianduerr.com>
2020-08-07 10:13:41 -04:00
Prebuilt binaries for macOS and Windows can also be downloaded from the
Remove outdated sections from README
2020-07-24 12:29:00 -04:00
[GitHub releases page](https://github.com/alacritty/alacritty/releases).
Document that alacritty requires winpty-agent on windows To make things easier to understand for Windows users, the relationship between Alacritty and the WinPTY agent has been clarified in the documentation. This also bundles the windows agent and exe together in a zip file to make distribution for windows easier on the user.
2019-02-02 07:00:29 -05:00
Rework installation instructions Since users should be capable of finding packages for their distributions, this removes all instructions that point users directly at specific packages. The third party repositories like COPR have been kept, since those are more difficult to find. The structure of the installation instructions has also been reworked to adjust for this and the post build instructions should be a bit cleaner now. Co-authored-by: Christian Duerr <contact@christianduerr.com>
2020-08-07 10:13:41 -04:00
For everyone else, the detailed instructions to install Alacritty can be found
[here](INSTALL.md).
Add Windows version requirements to readme Fixes #4846.
2021-02-28 12:12:24 -05:00
### Requirements
Add fallback GLES2 renderer Currently Alacritty only works on hardware which supports OpenGL 3.3 or more, which can become problematic with older devices. This patch adds a new GLES2 renderer, since it is much more widely supported, especially on weaker hardware like phones or a Raspberry Pi. While the GLES2 renderer is slower than the OpenGL 3.3+ version, it is still significantly faster than software rendering. However because of this performance difference it is only used when necessary and there should be no difference for machines supporting OpenGL 3.3+. The two renderers are largely independent and separated in the `renderer/text/glsl3` and `renderer/text/gles2` modules. Separate shaders are also required for text rendering. The rectangle rendering for underlines and the visual bell works identically for both versions, but does have some version-specific shader code. Fixes #128. Co-authored-by: Christian Duerr <contact@christianduerr.com>
2022-03-02 05:05:12 -05:00
- At least OpenGL ES 2.0
Add Windows version requirements to readme Fixes #4846.
2021-02-28 12:12:24 -05:00
- [Windows] ConPTY support (Windows 10 version 1809 or higher)
Add minimum OpenGL version to readme Fixes #4693.
2021-01-12 08:51:32 -05:00
Add Arch Linux package install instructions Includes minor touch ups.
2017-01-14 15:43:29 -05:00
## Configuration
Write README.md
2017-01-02 12:07:50 -05:00
Switch to TOML configuration format This switches Alacritty's default configuration format from yaml to toml. While yaml is still supported, it is done by converting it to toml and should be removed entirely in the future. All existing features were persisted based on my testing. Behavior should not change much, though `--option` might have slightly different behavior since the entire line is not interpreted as one line of toml. A new `alacritty migrate` subcommand has been added which allows automatic migration from yaml to toml. This also could be used as a facility to automatically fix configuration file changes in the future. Closes #6592.
2023-06-11 20:23:41 -04:00
You can find the documentation for Alacritty's configuration in `man 5
Add link to rendered config docs This adds a link to alacritty.org's rendered configuration file documentation.
2023-12-14 02:41:09 -05:00
alacritty`, or by looking at [the website] if you do not have the manpages
Switch to TOML configuration format This switches Alacritty's default configuration format from yaml to toml. While yaml is still supported, it is done by converting it to toml and should be removed entirely in the future. All existing features were persisted based on my testing. Behavior should not change much, though `--option` might have slightly different behavior since the entire line is not interpreted as one line of toml. A new `alacritty migrate` subcommand has been added which allows automatic migration from yaml to toml. This also could be used as a facility to automatically fix configuration file changes in the future. Closes #6592.
2023-06-11 20:23:41 -04:00
installed.
Add link to rendered config docs This adds a link to alacritty.org's rendered configuration file documentation.
2023-12-14 02:41:09 -05:00
[the website]: https://alacritty.org/config-alacritty.html
Remove automatic config generation Fixes #2818.
2019-10-06 06:47:20 -04:00
Document that Alacritty does not create config
2020-02-07 18:39:39 -05:00
Alacritty doesn't create the config file for you, but it looks for one in the
following locations:
Conform to XDG spec for configuration - Use $XDG_CONFIG_HOME/alacritty/alacritty.yml for loading the configuration file falling back to $HOME/.config/alacritty/alacritty.yml - Closes #203
2017-01-07 16:19:30 -05:00
Switch to TOML configuration format This switches Alacritty's default configuration format from yaml to toml. While yaml is still supported, it is done by converting it to toml and should be removed entirely in the future. All existing features were persisted based on my testing. Behavior should not change much, though `--option` might have slightly different behavior since the entire line is not interpreted as one line of toml. A new `alacritty migrate` subcommand has been added which allows automatic migration from yaml to toml. This also could be used as a facility to automatically fix configuration file changes in the future. Closes #6592.
2023-06-11 20:23:41 -04:00
1. `$XDG_CONFIG_HOME/alacritty/alacritty.toml`
2. `$XDG_CONFIG_HOME/alacritty.toml`
3. `$HOME/.config/alacritty/alacritty.toml`
4. `$HOME/.alacritty.toml`
Conform to XDG spec for configuration - Use $XDG_CONFIG_HOME/alacritty/alacritty.yml for loading the configuration file falling back to $HOME/.config/alacritty/alacritty.yml - Closes #203
2017-01-07 16:19:30 -05:00
Add support for Windows (#1374) Initial support for Windows is implemented using the winpty translation layer. Clipboard support for Windows is provided through the `clipboard` crate, and font rasterization is provided by RustType. The tty.rs file has been split into OS-specific files to separate standard pty handling from the winpty implementation. Several binary components are fetched via build script on windows including libclang and winpty. These could be integrated more directly in the future either by building those dependencies as part of the Alacritty build process or by leveraging git lfs to store the artifacts. Fixes #28.
2018-10-16 13:02:52 -04:00
### Windows
Document that Alacritty does not create config
2020-02-07 18:39:39 -05:00
On Windows, the config file should be located at:
Add support for Windows (#1374) Initial support for Windows is implemented using the winpty translation layer. Clipboard support for Windows is provided through the `clipboard` crate, and font rasterization is provided by RustType. The tty.rs file has been split into OS-specific files to separate standard pty handling from the winpty implementation. Several binary components are fetched via build script on windows including libclang and winpty. These could be integrated more directly in the future either by building those dependencies as part of the Alacritty build process or by leveraging git lfs to store the artifacts. Fixes #28.
2018-10-16 13:02:52 -04:00
Switch to TOML configuration format This switches Alacritty's default configuration format from yaml to toml. While yaml is still supported, it is done by converting it to toml and should be removed entirely in the future. All existing features were persisted based on my testing. Behavior should not change much, though `--option` might have slightly different behavior since the entire line is not interpreted as one line of toml. A new `alacritty migrate` subcommand has been added which allows automatic migration from yaml to toml. This also could be used as a facility to automatically fix configuration file changes in the future. Closes #6592.
2023-06-11 20:23:41 -04:00
`%APPDATA%\alacritty\alacritty.toml`
Add support for Windows (#1374) Initial support for Windows is implemented using the winpty translation layer. Clipboard support for Windows is provided through the `clipboard` crate, and font rasterization is provided by RustType. The tty.rs file has been split into OS-specific files to separate standard pty handling from the winpty implementation. Several binary components are fetched via build script on windows including libclang and winpty. These could be integrated more directly in the future either by building those dependencies as part of the Alacritty build process or by leveraging git lfs to store the artifacts. Fixes #28.
2018-10-16 13:02:52 -04:00
Set maximum Rust version to 1.31.0 By setting the minimum Rust version and enforcing it with CI, Alacritty should hopefully make it possible for maintainers to package the application even on distributions which are not rolling release. The 1.31.0 target has been chosen here because it's the first version of the Rust 2018 release. Bumping this version in the future should be considered to be a breaking change and should only be done with caution and in consideration of the supported Rust versions of the major distributions available. This fixes #2277.
2019-04-09 15:29:46 -04:00
## Contributing
Update Alacritty's description Alacritty's description in the readme and manpage has always been a bit overly aggressive in its marketing. This new updated text should more accurately describe Alacritty's current state without pointlessly agitating people.
2020-12-29 15:05:19 -05:00
A guideline about contributing to Alacritty can be found in the
Set maximum Rust version to 1.31.0 By setting the minimum Rust version and enforcing it with CI, Alacritty should hopefully make it possible for maintainers to package the application even on distributions which are not rolling release. The 1.31.0 target has been chosen here because it's the first version of the Rust 2018 release. Bumping this version in the future should be considered to be a breaking change and should only be done with caution and in consideration of the supported Rust versions of the major distributions available. This fixes #2277.
2019-04-09 15:29:46 -04:00
[`CONTRIBUTING.md`](CONTRIBUTING.md) file.
Write README.md
2017-01-02 12:07:50 -05:00
## FAQ
Add support for Windows (#1374) Initial support for Windows is implemented using the winpty translation layer. Clipboard support for Windows is provided through the `clipboard` crate, and font rasterization is provided by RustType. The tty.rs file has been split into OS-specific files to separate standard pty handling from the winpty implementation. Several binary components are fetched via build script on windows including libclang and winpty. These could be integrated more directly in the future either by building those dependencies as part of the Alacritty build process or by leveraging git lfs to store the artifacts. Fixes #28.
2018-10-16 13:02:52 -04:00
**_Is it really the fastest terminal emulator?_**
Fix typo
2018-02-27 22:48:37 -05:00
Update Alacritty's description Alacritty's description in the readme and manpage has always been a bit overly aggressive in its marketing. This new updated text should more accurately describe Alacritty's current state without pointlessly agitating people.
2020-12-29 15:05:19 -05: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.
Small Updates to the README (#2091) Update the README and related files. This commit generally updates some language in the "About" section, and other sections with respect to keeping accurate information, and laying out the project goals in a clear way. We're also marking Alacritty as "beta" software at this point, not that this has any explicit meaning.
2019-02-18 14:54:46 -05: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.
Fix typo
2018-02-27 22:48:37 -05:00
Change the way we refer to IRC chat
2023-06-13 00:54:17 -04:00
[tmux]: https://github.com/tmux/tmux
Update README.md with more Wayland Adds a call to action on how to improve Wayland support in Alacritty.
2017-10-21 20:06:47 -04:00
Write README.md
2017-01-02 12:07:50 -05:00
## License
Alacritty is released under the [Apache License, Version 2.0].
Move Alacritty to organization This fixes various outdated links pointing to the old jwilm/alacritty repository. Since `copypasta` now has its own github repository at https://github.com/alacritty/copypasta, the sources have been removed from Alacritty.
2020-01-10 20:23:13 -05:00
[Apache License, Version 2.0]: https://github.com/alacritty/alacritty/blob/master/LICENSE-APACHE
Copy permalink