diff options
| -rw-r--r-- | INSTALL.md | 129 | ||||
| -rw-r--r-- | README.md | 125 |
2 files changed, 83 insertions, 171 deletions
@@ -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 1. [Prerequisites](#prerequisites) @@ -22,15 +46,15 @@ 16. [Other](#other) 2. [Building](#building) 1. [Linux/Windows](#linux--windows) - 1. [Desktop Entry](#desktop-entry) - 2. [MacOS](#macos) - 3. [Cargo](#cargo) -3. [Manual Page](#manual-page) -4. [Shell Completions](#shell-completions) - 1. [Zsh](#zsh) - 2. [Bash](#bash) - 3. [Fish](#fish) -5. [Terminfo](#terminfo) + 2. [macOS](#macos) +3. [Post Build](#post-build) + 1. [Terminfo](#terminfo) + 2. [Desktop Entry](#desktop-entry) + 3. [Manual Page](#manual-page) + 4. [Shell completions](#shell-completions) + 1. [Zsh](#zsh) + 2. [Bash](#bash) + 3. [Fish](#fish) ## Prerequisites @@ -213,8 +237,6 @@ filling in this section of the README. ### Linux / Windows -Once all the prerequisites are installed, compiling Alacritty should be easy: - ```sh cargo build --release ``` @@ -222,53 +244,69 @@ cargo build --release If all goes well, this should place a binary at `target/release/alacritty`. On Windows this directory should also contain the `winpty-agent.exe`. -#### Desktop Entry - -Many linux distributions support desktop entries for adding applications to -system menus. To install the desktop entry for Alacritty, run +### macOS ```sh -sudo cp target/release/alacritty /usr/local/bin # or anywhere else in $PATH -sudo cp extra/logo/alacritty-term.svg /usr/share/pixmaps/Alacritty.svg -sudo desktop-file-install extra/linux/Alacritty.desktop -sudo update-desktop-database +make app +cp -r target/release/osx/Alacritty.app /Applications/ ``` -You can find a prerendered SVG logo as well as simplified versions of the SVG in -the `extra/logo/compat` directory. +## 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 -### MacOS +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. -To build an application for macOS, run +If the following command returns without any errors, the `alacritty` terminfo is +already installed: ```sh -make app -cp -r target/release/osx/Alacritty.app /Applications/ +infocmp alacritty ``` -### Cargo +If it is not present already, you can install it globally with the following +command: + +``` +sudo tic -xe alacritty,alacritty-direct extra/alacritty.info +``` -If you don't want to clone the repository, you can install Alacritty directly using cargo: +### 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 -cargo install --git https://github.com/alacritty/alacritty +sudo cp target/release/alacritty /usr/local/bin # or anywhere else in $PATH +sudo cp extra/logo/alacritty-term.svg /usr/share/pixmaps/Alacritty.svg +sudo desktop-file-install extra/linux/Alacritty.desktop +sudo update-desktop-database ``` -## Manual Page +If you are having problems with Alacritty's logo, you can replace it with +prerendered PNGs and simplified SVGs available in the `extra/logo/compat` +directory. + +### Manual Page Installing the manual page requires the additional dependency `gzip`. -To install the manual page, run ```sh 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 ``` -## 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 directory referenced by `$fpath`. @@ -286,7 +324,7 @@ Then copy the completion file to this directory: 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 in your `~/.bashrc` file. @@ -305,7 +343,7 @@ cp extra/completions/alacritty.bash ~/.bash_completion/alacritty echo "source ~/.bash_completion/alacritty" >> ~/.bashrc ``` -### Fish +#### Fish To install the completions for fish, run @@ -313,24 +351,3 @@ To install the completions for fish, run mkdir -p $fish_complete_path[1] 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 -``` @@ -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 |