From b8dc61172435838deb62a6805a1fe594f3b9b023 Mon Sep 17 00:00:00 2001 From: olegrezi <90209759+olegrezi@users.noreply.github.com> Date: Fri, 17 Sep 2021 13:23:45 +0300 Subject: [PATCH] Updated Home (markdown) --- Home.md | 119 +++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 113 insertions(+), 6 deletions(-) diff --git a/Home.md b/Home.md index b226ed9..8fc0308 100644 --- a/Home.md +++ b/Home.md @@ -1,9 +1,116 @@ -# Alacritty Wiki +

+ Alacritty Logo +

-Welcome to the `alacritty` wiki! Please feel free to edit this, but be respectful. Accurate additions are a welcome change. We have an active IRC (`#alacritty` on [Libera.Chat](https://libera.chat/)), so please feel free to reach out. +

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

-## Sections -- [ANSI References](https://github.com/jwilm/alacritty/wiki/ANSI-references) -- [Color Schemes](https://github.com/jwilm/alacritty/wiki/Color-schemes) -- [Keyboard Mappings](https://github.com/jwilm/alacritty/wiki/Keyboard-mappings) \ No newline at end of file + +## Installation, Documentation and Examples + +      Alacritty for Windows + +      Alacritty for Mac + +      Alacritty for Linux + +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. + +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](https://github.com/alacritty/alacritty/releases). + +## Features + +You can find an overview over the features available in Alacritty [here](./docs/features.md). + +## Further information + +- [Announcing Alacritty, a GPU-Accelerated Terminal Emulator](https://jwilm.io/blog/announcing-alacritty/) January 6, 2017 +- [A talk about Alacritty at the Rust Meetup January 2017](https://www.youtube.com/watch?v=qHOdYO3WUTk) January 19, 2017 +- [Alacritty Lands Scrollback, Publishes Benchmarks](https://jwilm.io/blog/alacritty-lands-scrollback/) September 17, 2018 +- [Version 0.3.0 Release Announcement](https://blog.christianduerr.com/alacritty_030_announcement) April 07, 2019 +- [Version 0.5.0 Release Announcement](https://blog.christianduerr.com/alacritty_0_5_0_announcement) July 31, 2020 + +## 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](https://github.com/alacritty/alacritty/releases). + +For everyone else, the detailed instructions to install Alacritty can be found +[here](INSTALL.md). + +### Requirements + +- OpenGL 3.3 or higher +- [Windows] ConPTY support (Windows 10 version 1809 or higher) + +## Configuration + +You can find the default configuration file with documentation for all available +fields on the [GitHub releases page](https://github.com/alacritty/alacritty/releases) 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`](CONTRIBUTING.md) file. + +## FAQ + +**_Is it really the fastest terminal emulator?_** + +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. + +**_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. + +## IRC + +Alacritty discussions can be found in `#alacritty` on Libera.Chat. + +## License + +Alacritty is released under the [Apache License, Version 2.0]. + +[Apache License, Version 2.0]: https://github.com/alacritty/alacritty/blob/master/LICENSE-APACHE +[tmux]: https://github.com/tmux/tmux