PolytreeDE/alacritty
1
0
Fork 0
mirror of https://github.com/alacritty/alacritty.git synced 2024-11-25 14:05:41 -05:00
Code Releases Activity

Rework installation instructions

Browse source 
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>
This commit is contained in:
Canh Dinh 2020-08-07 21:13:41 +07:00 committed by GitHub
parent c478a9fc52
commit b14d032432
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 88 additions and 176 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

139
INSTALL.md
View file

@ -1,3 +1,27 @@
# Third Party Repositories
For distributions that do not ship Alacritty officially, there are some third
party packages available. Only the cargo package is maintained officially, so
proceed with caution.
## [Fedora](https://copr.fedorainfracloud.org/coprs/pschyska/alacritty)
```
# dnf copr enable pschyska/alacritty
# dnf install alacritty
```
## Cargo
If you're just interested in the Alacritty binary and you don't need the
[terminfo file](#terminfo), [desktop entry](#desktop-entry),
[manual page](#manual-page) or [shell completions](#shell-completions), you can
install it directly through cargo:
```sh
cargo install alacritty
```
# Manual Installation # Manual Installation
1. [Prerequisites](#prerequisites) 1. [Prerequisites](#prerequisites)
@ -22,15 +46,15 @@
16. [Other](#other) 16. [Other](#other)
2. [Building](#building) 2. [Building](#building)
1. [Linux/Windows](#linux--windows) 1. [Linux/Windows](#linux--windows)
1. [Desktop Entry](#desktop-entry) 2. [macOS](#macos)
2. [MacOS](#macos) 3. [Post Build](#post-build)
3. [Cargo](#cargo) 1. [Terminfo](#terminfo)
3. [Manual Page](#manual-page) 2. [Desktop Entry](#desktop-entry)
4. [Shell Completions](#shell-completions) 3. [Manual Page](#manual-page)
1. [Zsh](#zsh) 4. [Shell completions](#shell-completions)
2. [Bash](#bash) 1. [Zsh](#zsh)
3. [Fish](#fish) 2. [Bash](#bash)
5. [Terminfo](#terminfo) 3. [Fish](#fish)
## Prerequisites ## Prerequisites
@ -213,8 +237,6 @@ filling in this section of the README.
### Linux / Windows ### Linux / Windows
Once all the prerequisites are installed, compiling Alacritty should be easy:
```sh ```sh
cargo build --release cargo build --release
``` ```
@ -222,10 +244,43 @@ cargo build --release
If all goes well, this should place a binary at `target/release/alacritty`. If all goes well, this should place a binary at `target/release/alacritty`.
On Windows this directory should also contain the `winpty-agent.exe`. On Windows this directory should also contain the `winpty-agent.exe`.
#### Desktop Entry ### macOS
Many linux distributions support desktop entries for adding applications to ```sh
system menus. To install the desktop entry for Alacritty, run make app
cp -r target/release/osx/Alacritty.app /Applications/
```
## Post Build
There are some extra things you might want to set up after installing Alacritty.
All the post build instruction assume you're still inside the Alacritty
repository.
### Terminfo
To make sure Alacritty works correctly, either the `alacritty` or
`alacritty-direct` terminfo must be used. The `alacritty` terminfo will be
picked up automatically if it is installed.
If the following command returns without any errors, the `alacritty` terminfo is
already installed:
```sh
infocmp alacritty
```
If it is not present already, you can install it globally with the following
command:
```
sudo tic -xe alacritty,alacritty-direct extra/alacritty.info
```
### Desktop Entry
Many Linux and BSD distributions support desktop entries for adding applications
to system menus. This will install the desktop entry for Alacritty:
```sh ```sh
sudo cp target/release/alacritty /usr/local/bin # or anywhere else in $PATH sudo cp target/release/alacritty /usr/local/bin # or anywhere else in $PATH
@ -234,41 +289,24 @@ sudo desktop-file-install extra/linux/Alacritty.desktop
sudo update-desktop-database sudo update-desktop-database
``` ```
You can find a prerendered SVG logo as well as simplified versions of the SVG in If you are having problems with Alacritty's logo, you can replace it with
the `extra/logo/compat` directory. prerendered PNGs and simplified SVGs available in the `extra/logo/compat`
directory.
### MacOS ### Manual Page
To build an application for macOS, run
```sh
make app
cp -r target/release/osx/Alacritty.app /Applications/
```
### Cargo
If you don't want to clone the repository, you can install Alacritty directly using cargo:
```sh
cargo install --git https://github.com/alacritty/alacritty
```
## Manual Page
Installing the manual page requires the additional dependency `gzip`. Installing the manual page requires the additional dependency `gzip`.
To install the manual page, run
```sh ```sh
sudo mkdir -p /usr/local/share/man/man1 sudo mkdir -p /usr/local/share/man/man1
gzip -c extra/alacritty.man | sudo tee /usr/local/share/man/man1/alacritty.1.gz > /dev/null gzip -c extra/alacritty.man | sudo tee /usr/local/share/man/man1/alacritty.1.gz > /dev/null
``` ```
## Shell completions ### Shell completions
To get automatic completions for alacritty's flags and arguments you can install the provided shell completions. To get automatic completions for Alacritty's flags and arguments you can install the provided shell completions.
### Zsh #### Zsh
To install the completions for zsh, you can place the `extra/completions/_alacritty` file in any To install the completions for zsh, you can place the `extra/completions/_alacritty` file in any
directory referenced by `$fpath`. directory referenced by `$fpath`.
@ -286,7 +324,7 @@ Then copy the completion file to this directory:
cp extra/completions/_alacritty ${ZDOTDIR:-~}/.zsh_functions/_alacritty cp extra/completions/_alacritty ${ZDOTDIR:-~}/.zsh_functions/_alacritty
``` ```
### Bash #### Bash
To install the completions for bash, you can `source` the `extra/completions/alacritty.bash` file To install the completions for bash, you can `source` the `extra/completions/alacritty.bash` file
in your `~/.bashrc` file. in your `~/.bashrc` file.
@ -305,7 +343,7 @@ cp extra/completions/alacritty.bash ~/.bash_completion/alacritty
echo "source ~/.bash_completion/alacritty" >> ~/.bashrc echo "source ~/.bash_completion/alacritty" >> ~/.bashrc
``` ```
### Fish #### Fish
To install the completions for fish, run To install the completions for fish, run
@ -313,24 +351,3 @@ To install the completions for fish, run
mkdir -p $fish_complete_path[1] mkdir -p $fish_complete_path[1]
cp extra/completions/alacritty.fish $fish_complete_path[1]/alacritty.fish cp extra/completions/alacritty.fish $fish_complete_path[1]/alacritty.fish
``` ```
## Terminfo
The terminfo database contains entries describing the terminal
emulator's capabilities. Programs need these in order to function
properly.
Alacritty should work with the standard `xterm-256color` definition,
but to allow programs to make best use of alacritty's capabilities,
use its own terminfo definition instead.
Unless the user has set the `TERM` environment variable in the
alacritty configuration, the `alacritty` terminfo definition will be
used if it has been installed. If not, then `xterm-256color` is used
instead.
To install alacritty's terminfo entry globally:
```sh
sudo tic -xe alacritty,alacritty-direct extra/alacritty.info
```

125
README.md
View file

@ -42,126 +42,21 @@ You can find an overview over the features available in Alacritty [here](./docs/
## Installation ## Installation
Some operating systems already provide binaries for Alacritty, for everyone Alacritty can be installed by using various package managers on Linux, BSD,
else the instructions to build Alacritty from source can be found [here](INSTALL.md). macOS and Windows.
### Alpine Linux Prebuilt binaries for macOS and Windows can also be downloaded from the
```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
[GitHub releases page](https://github.com/alacritty/alacritty/releases). [GitHub releases page](https://github.com/alacritty/alacritty/releases).
On Windows, Alacritty also requires Microsoft's VC++ redistributable. On Windows, Alacritty requires winpty to emulate UNIX's PTY API for versions
older than Windows 10 (October 2018 Update) and Microsoft's VC++
For Windows versions older than Windows 10 (October 2018 Update), Alacritty redistributable. The winpty agent (`winpty-agent.exe`) **must** be in the same
requires winpty to emulate UNIX's PTY API. The agent is a single binary directory as the Alacritty executable and is available through the
(`winpty-agent.exe`) which **must** be in the same directory as the Alacritty
executable and is available through the
[GitHub releases page](https://github.com/alacritty/alacritty/releases). [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 ## Configuration
You can find the default configuration file with documentation for all available You can find the default configuration file with documentation for all available