aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md17
1 files changed, 14 insertions, 3 deletions
diff --git a/README.md b/README.md
index e2b81e24..33a6feb1 100644
--- a/README.md
+++ b/README.md
@@ -273,9 +273,6 @@ Just Works.
on another machine which is connected to Alacritty via SSH, this issue
disappears. Actual throughput and rendering performance are still better in
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.
Contributors would be welcomed :).
- _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.
+## 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
Alacritty is released under the [Apache License, Version 2.0].
[Apache License, Version 2.0]: https://github.com/jwilm/alacritty/blob/readme/LICENSE-APACHE
[tmux]: https://github.com/tmux/tmux
+[Wayland meta issue]: https://github.com/tomaka/winit/issues/306