Commit graph

140 commits

Author SHA1 Message Date
Christian Duerr 0be25c5e22
Switch official IRC channel to Libera.Chat 2021-06-19 13:29:30 +00:00
r-c-f 557b28d0ac
Add Windows version requirements to readme
Fixes #4846.
2021-02-28 17:12:24 +00:00
Christian Duerr 753c4ed19e
Fix dead Alacritty talk link in readme 2021-01-18 11:17:04 +00:00
Christian Duerr 80f7adf20f
Fix typo in README.md 2021-01-12 20:09:44 +00:00
Christian Duerr ab9d5a7452
Add minimum OpenGL version to readme
Fixes #4693.
2021-01-12 13:51:32 +00:00
Alex Touchet 7045a1ec07
Fix readme logo icon URL 2021-01-09 17:05:25 +00:00
Christian Duerr 8ed72cc065
Remove Windows WinPTY backend 2021-01-01 05:07:39 +00:00
Christian Duerr 65f6e22bb4
Fix readme image alt description 2020-12-29 23:47:53 +00:00
Christian Duerr 3d7b16d4b0
Update Alacritty's description
Alacritty's description in the readme and manpage has always been a bit
overly aggressive in its marketing. This new updated text should more
accurately describe Alacritty's current state without pointlessly
agitating people.
2020-12-29 20:05:19 +00:00
Canh Dinh b14d032432
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>
2020-08-07 14:13:41 +00:00
Raphael Martin Schindler d55d09ee68
Fix typo in readme 2020-08-02 15:32:08 +00:00
Kirill Chibisov d192720f90 Add 0.5.0 announcement blog to readme
This is only an update to the readme and does not represent a stable
release.
2020-08-01 00:38:28 +00:00
Christian Duerr 555a85ed95
Remove outdated sections from README 2020-07-24 16:29:00 +00:00
Christian Duerr d7425979cf
Document Alacritty's features 2020-07-23 22:32:38 +00:00
Christian Duerr 41127a1e72
Remove Ubuntu PPA installation instructions
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-16 01:33:40 +00:00
Andrew Zhou 466f95d3ba
Add auxiliary files to macOS Application bundle
Fixes #2653.
2020-07-04 14:03:48 +00:00
Steve Dondley 00870b2c5c
Improve documentation for install on macOS via brew cask 2020-06-15 01:06:14 +03:00
Valentin Ignatev 31e01cc0e0
Add GNU Guix installation instructions 2020-03-01 04:33:36 +03:00
bgkillas 933b2e25ff
Add Alpine Linux installation instructions 2020-02-18 00:15:05 +00:00
Kirill Chibisov 5cd13f8c47
Document that Alacritty does not create config 2020-02-07 23:39:39 +00:00
Christian Duerr c2c8d6bf37
Move Alacritty to organization
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.
2020-01-11 02:23:13 +01:00
Kirill Chibisov d4dc1f7b14 Remove outdated information from README 2019-12-29 22:48:27 +00:00
David Hewitt 7a957978e4 Default to ConPTY instead of WinPTY 2019-12-21 21:23:18 +00:00
jansol 1836d4679a Add prerendered PNG and simplified SVG logo
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-11-28 19:09:14 +01:00
Kirill Chibisov 24651a6144 Remove automatic config generation
Fixes #2818.
2019-10-06 12:47:20 +02:00
Alex Touchet 28b726cbfa Organize Readme OS list 2019-08-01 04:58:32 +00:00
Paul Schyska 3950b5cb2f Add Fedora Copr install instructions 2019-06-16 19:47:59 +00:00
Michael Murphy 7738c52ed4 Add Ubuntu PPA install instructions 2019-05-09 17:56:34 +00:00
trimental cf1a35bcb4 Update wayland comment in README 2019-04-23 15:27:34 +00:00
Michael Murphy d406627acb Add Pop!_OS to the list of supported Linux distros 2019-04-10 18:29:53 +00:00
Alex Touchet 94ab5f2b5b Switch 0.3.0 announcement link to https 2019-04-10 18:11:20 +00:00
Christian Duerr 272a583bd0
Document VC++ redistributable requirement
This fixes #1972.
2019-04-09 21:05:26 +00:00
Christian Duerr 56fea343ff
Set maximum Rust version to 1.31.0
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-09 19:29:46 +00:00
Christian Duerr f2a5def2cb
Add 0.3.0 announcement blog to readme 2019-04-09 16:54:09 +00:00
Christian Duerr 6f4d1afcf8
Add official logo 2019-04-01 22:41:20 +00:00
Christian Duerr ba9aaa0539
Remove appveyor badge from readme 2019-03-04 16:23:19 +00:00
Starz0r 8d5e1226d5 Add install instructions for Chocolatey to readme 2019-02-25 23:45:17 +00:00
Nathan Lilienthal 66b3f4c877
Small Updates to the README (#2091)
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-18 14:54:46 -05:00
Zac Pullar-Strecker 863d5581a6 Document that alacritty requires winpty-agent on windows
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-02-02 12:00:29 +00:00
Christian Duerr 0d16478f5d
Make all configuration fields optional
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-17 09:17:26 +00:00
Robert Günzler 4caf3d32cd Add Solus install instructions to README 2019-01-12 19:55:03 +00:00
Christian Duerr ec6f756946
Fix Windows config location documontation
The path `%APPDATA%` already includes the `Roaming` folder.
2018-12-28 15:26:58 +00:00
Zac Pullar-Strecker 6d7647c890 Make windows config location more sensible 2018-12-27 14:16:31 +00:00
kekePower e1ee890750 Add Mageia install instructions to README.md 2018-12-18 21:41:17 +00:00
Ross Smith II e4db833137 Add scoop install instructions for windows 2018-12-14 10:00:50 +00:00
Ryan Morey 3593ec72dd Add NixOS install instructions to README.md 2018-11-17 18:29:08 +00:00
Fintan ba76ac8661 Document homebrew cask option for macOS installation 2018-11-15 13:58:24 +00:00
Hellsenberg 5baf1fceab Move .deb building instructions to INSTALL.md
This fixes #1541.
2018-11-14 21:49:34 +00:00
Alex Touchet 81617983bb Fix grammatical errors in README 2018-11-07 20:04:41 +00:00
Christian Duerr 0e49bfb02a
Update readme to link to the github releases 2018-11-04 00:13:18 +00:00