Update README.md with more Wayland

Adds a call to action on how to improve Wayland support in Alacritty.
This commit is contained in:
Joe Wilm 2017-10-21 17:06:47 -07:00
parent f6f2bcd024
commit 8af4a4b55b
1 changed files with 14 additions and 3 deletions

View File

@ -273,9 +273,6 @@ Just Works.
on another machine which is connected to Alacritty via SSH, this issue on another machine which is connected to Alacritty via SSH, this issue
disappears. Actual throughput and rendering performance are still better in disappears. Actual throughput and rendering performance are still better in
Alacritty. Alacritty.
- _Is wayland supported?_ Sort of, but not everything works. To prefer X11 over
Wayland (e.g. for use on XWayland) launch Alacritty like this:
`env WAYLAND_DISPLAY= alacritty`
- _When will Windows support be available?_ When someone has time to work on it. - _When will Windows support be available?_ When someone has time to work on it.
Contributors would be welcomed :). Contributors would be welcomed :).
- _My arrow keys don't work_. It sounds like you deleted some key bindings from - _My arrow keys don't work_. It sounds like you deleted some key bindings from
@ -289,9 +286,23 @@ Just Works.
Alacritty discussion can be found in `#alacritty` on freenode. Alacritty discussion can be found in `#alacritty` on freenode.
## Wayland
Wayland support is available, but not everything works as expected. Many people
have found a better experience using XWayland which can be achieved launching
Alacritty with the `WAYLAND_DISPLAY` environment variable cleared:
```sh
env WAYLAND_DISPLAY= alacritty
```
If you're interested in seeing our Wayland support improve, please head over to
the [Wayland meta issue] on the _winit_ project to see how you may contribute.
## License ## License
Alacritty is released under the [Apache License, Version 2.0]. Alacritty is released under the [Apache License, Version 2.0].
[Apache License, Version 2.0]: https://github.com/jwilm/alacritty/blob/readme/LICENSE-APACHE [Apache License, Version 2.0]: https://github.com/jwilm/alacritty/blob/readme/LICENSE-APACHE
[tmux]: https://github.com/tmux/tmux [tmux]: https://github.com/tmux/tmux
[Wayland meta issue]: https://github.com/tomaka/winit/issues/306