aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCanh Dinh <vancanhuit@users.noreply.github.com>2020-08-07 21:13:41 +0700
committerGitHub <noreply@github.com>2020-08-07 14:13:41 +0000
commitb14d032432c9502d2aac0b01ecc957d92672eada (patch)
tree124ff998b63d7e57af77935380a7ab249e145c02 /README.md
parentc478a9fc526828d7d05c7e6189126b47ec4b8122 (diff)
downloadalacritty-b14d032432c9502d2aac0b01ecc957d92672eada.tar.gz
alacritty-b14d032432c9502d2aac0b01ecc957d92672eada.zip
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>
Diffstat (limited to 'README.md')
-rw-r--r--README.md125
1 files changed, 10 insertions, 115 deletions
diff --git a/README.md b/README.md
index fac22fed..a86621f3 100644
--- a/README.md
+++ b/README.md
@@ -42,126 +42,21 @@ You can find an overview over the features available in Alacritty [here](./docs/
## Installation
-Some operating systems already provide binaries for Alacritty, for everyone
-else the instructions to build Alacritty from source can be found [here](INSTALL.md).
+Alacritty can be installed by using various package managers on Linux, BSD,
+macOS and Windows.
-### Alpine Linux
-
-```sh
-apk add alacritty
-```
-
-### Arch Linux
-
-```sh
-pacman -S alacritty
-```
-
-### Fedora
-
-Unofficial builds of stable tags can be found in Fedora Copr:
-[pschyska/alacritty](https://copr.fedorainfracloud.org/coprs/pschyska/alacritty/).
-
-``` sh
-dnf copr enable pschyska/alacritty
-dnf install alacritty
-```
-
-If you want to help test pre-releases, you can additionally enable
-[pschyska/alacritty-testing](https://copr.fedorainfracloud.org/coprs/pschyska/alacritty-testing/).
-
-### Gentoo Linux
-
-```sh
-emerge x11-terms/alacritty
-```
-
-### GNU Guix
-
-```sh
-guix package -i alacritty
-```
-
-### Mageia
-
-```sh
-urpmi alacritty
-```
-
-### NixOS
-
-```sh
-nix-env -iA nixos.alacritty
-```
-
-### openSUSE Tumbleweed
-
-```sh
-zypper in alacritty
-```
-
-### Pop!\_OS
-
-```sh
-apt install alacritty
-```
-
-### Solus
-
-```sh
-eopkg install alacritty
-```
-
-### Void Linux
-
-```sh
-xbps-install alacritty
-```
-
-### FreeBSD
-
-```sh
-pkg install alacritty
-```
-
-### macOS
-
-```sh
-brew cask install alacritty
-```
-
-Once the cask is installed, it is recommended to set up the manual page, shell
-completions, and terminfo definitions. These are located inside the installed
-application's Resources directory: `Alacritty.app/Contents/Resources`.
-
-### Windows
-
-#### Via [Chocolatey](https://chocolatey.org)
-
-```batch
-choco install alacritty
-```
-
-#### Via [Scoop](https://scoop.sh)
-
-```batch
-scoop bucket add extras
-scoop install alacritty
-```
-
-### Other
-
-Prebuilt binaries for macOS, and Windows can be downloaded from the
+Prebuilt binaries for macOS and Windows can also be downloaded from the
[GitHub releases page](https://github.com/alacritty/alacritty/releases).
-On Windows, Alacritty also requires Microsoft's VC++ redistributable.
-
-For Windows versions older than Windows 10 (October 2018 Update), Alacritty
-requires winpty to emulate UNIX's PTY API. The agent is a single binary
-(`winpty-agent.exe`) which **must** be in the same directory as the Alacritty
-executable and is available through the
+On Windows, Alacritty requires winpty to emulate UNIX's PTY API for versions
+older than Windows 10 (October 2018 Update) and Microsoft's VC++
+redistributable. The winpty agent (`winpty-agent.exe`) **must** be in the same
+directory as the Alacritty executable and is available through 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).
+
## Configuration
You can find the default configuration file with documentation for all available