summaryrefslogtreecommitdiffstats
path: root/README.md
AgeCommit message (Collapse)Author
2020-08-07Rework installation instructionsCanh Dinh
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-02Fix typo in readmeRaphael Martin Schindler
2020-08-01Add 0.5.0 announcement blog to readmeKirill Chibisov
This is only an update to the readme and does not represent a stable release.
2020-07-24Remove outdated sections from READMEChristian Duerr
2020-07-23Document Alacritty's featuresChristian Duerr
2020-07-16Remove Ubuntu PPA installation instructionsChristian Duerr
Since the Ubuntu PPA from mmstick is apparently not maintained anymore, people should no longer be instructed to install the outdated version that is available from the PPA. The System76 PPA repository still contains an up to date version of Alacritty, but since it also comes with several other packages we cannot recommend users to install it outside of Pop!_OS. Fixes #3863.
2020-07-04Add auxiliary files to macOS Application bundleAndrew Zhou
Fixes #2653.
2020-06-15Improve documentation for install on macOS via brew caskSteve Dondley
2020-03-01Add GNU Guix installation instructionsValentin Ignatev
2020-02-18Add Alpine Linux installation instructionsbgkillas
2020-02-07Document that Alacritty does not create configKirill Chibisov
2020-01-11Move Alacritty to organizationChristian Duerr
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.
2019-12-29Remove outdated information from READMEKirill Chibisov
2019-12-21Default to ConPTY instead of WinPTYDavid Hewitt
2019-11-28Add prerendered PNG and simplified SVG logojansol
This should help with compatibility problems with some platforms like KDE, that do not support all the features necessary for rendering the default Alacritty logo.
2019-10-06Remove automatic config generationKirill Chibisov
Fixes #2818.
2019-08-01Organize Readme OS listAlex Touchet
2019-06-16Add Fedora Copr install instructionsPaul Schyska
2019-05-09Add Ubuntu PPA install instructionsMichael Murphy
2019-04-23Update wayland comment in READMEtrimental
2019-04-10Add Pop!_OS to the list of supported Linux distrosMichael Murphy
2019-04-10Switch 0.3.0 announcement link to httpsAlex Touchet
2019-04-09Document VC++ redistributable requirementChristian Duerr
This fixes #1972.
2019-04-09Set maximum Rust version to 1.31.0Christian Duerr
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-09Add 0.3.0 announcement blog to readmeChristian Duerr
2019-04-01Add official logov0.3.0-rc2Christian Duerr
2019-03-04Remove appveyor badge from readmeChristian Duerr
2019-02-25Add install instructions for Chocolatey to readmeStarz0r
2019-02-18Small Updates to the README (#2091)Nathan Lilienthal
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-02Document that alacritty requires winpty-agent on windows Zac Pullar-Strecker
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-01-17Make all configuration fields optionalChristian Duerr
All configuration fields now have fallback values which will be used if the field is not present. This includes mouse, key bindings and platform specific differences. The mouse and key bindings are now filled by default, if the user rebinds a default mapping, it will be overwritten. To unbind a default binding, it can be mapped to `chars: ""`. Since all platform differences can now be correctly handled by the `src/config/mod.rs` code, it's no longer necessary to maintain separate configuration files, so the `alacritty_macos.yml` and `alacritty_windows.yml` have been deleted. Fixes #40. Fixes #1923.
2019-01-12Add Solus install instructions to READMERobert Günzler
2018-12-28Fix Windows config location documontationChristian Duerr
The path `%APPDATA%` already includes the `Roaming` folder.
2018-12-27Make windows config location more sensibleZac Pullar-Strecker
2018-12-18Add Mageia install instructions to README.mdkekePower
2018-12-14Add scoop install instructions for windowsRoss Smith II
2018-11-17Add NixOS install instructions to README.mdRyan Morey
2018-11-15Document homebrew cask option for macOS installationFintan
2018-11-14Move .deb building instructions to INSTALL.mdHellsenberg
This fixes #1541.
2018-11-07Fix grammatical errors in READMEAlex Touchet
2018-11-04Update readme to link to the github releasesChristian Duerr
2018-11-01Add Instructions for installing on FreeBSDNiclas Zeising
Readd instructions for how to install pre-compiled alacritty packages on FreeBSD. This was accidentaly removed in cb6e065.
2018-10-27Add official Gentoo package to install instructionsGeorgy Yakovlev
2018-10-27Move gentoo install instructions, add windows to table of contentsZac Pullar-Strecker
2018-10-16Fix appveyor badge linkChristian Duerr
2018-10-16Add support for Windows (#1374)Zac Pullar-Strecker
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-14Extract manual installation instructionsChristian Duerr
Alacritty's manual installation instructions take up a lot of space in the README and they are hard to navigate because there's a lot of information for specific distros which are irrelevant to most users. To improve this situation, the manual installation section has been moved to the `INSTALL.md` file. This allows keeping the readme to a minimum which just includes the straight-forward instructions required to install it on systems which provide packages for it. Having a separate file also makes it possible to add a full index just for the installation instructions, which makes it possible to skip sections which are irrelevant.
2018-09-28Add note about package install on FreeBSDNiclas Zeising
2018-09-24Add standalone terminfo definitionDaniel Eklöf
This replaces the current definitions, which depend on the system's 'xterm-256color' terminfo definition with the `alacritty` and `alacritty-direct` definitions. The new definitions are completely standalone. The default `TERM` value has been changed to be dynamically set based on the definitions installed on the system. Alacritty will try to use the `alacritty` definition first and fall back to `xterm-256color` if the `alacritty` definition is not present.
2018-09-17Add `fontconfig-devel` dependency for building on Void LinuxVoidNoire