Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme: Update Running on Wayland guide #4199

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions docs/USER-DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,17 +86,15 @@ you want to learn more.
Running on Wayland
------------------

Electron is based on Gtk2, which can't run natively on Wayland. Fortunately,
the [XWayland Server][xwayland] provides backwards compatibility to run *any* X
client on Wayland, including Etcher.

This usually works out of the box on mainstream GNU/Linux distributions that
properly support Wayland. If it doesn't, make sure the `xwayland.so` module is
being loaded by declaring it in your [weston.ini]:
You can run Etcher on Wayland by passing command line flags
kawaii-ghost marked this conversation as resolved.
Show resolved Hide resolved

```sh
$ balena-etcher --enable-features=WaylandWindowDecorations --ozone-platform=wayland
kawaii-ghost marked this conversation as resolved.
Show resolved Hide resolved
```
[core]
modules=xwayland.so
To make this changes permanent to the desktop entry
kawaii-ghost marked this conversation as resolved.
Show resolved Hide resolved
```sh
$ cp /usr/share/applications/balena-etcher.desktop ~/.local/share/applications
$ sed -i 's|^Exec=/opt/balenaEtcher/balena-etcher %U$|Exec=/opt/balenaEtcher/balena-etcher --enable-features=WaylandWindowDecorations --ozone-platform=wayland %U|' ~/.local/share/applications/balena-etcher.desktop
kawaii-ghost marked this conversation as resolved.
Show resolved Hide resolved
```

Runtime GNU/Linux dependencies
Expand Down Expand Up @@ -224,4 +222,4 @@ macOS 10.10 (Yosemite) and newer versions][electron-supported-platforms].
[windows-iot-dashboard]: https://developer.microsoft.com/en-us/windows/iot/downloads
[woeusb]: https://github.com/slacka/WoeUSB

See [PUBLISHING](/docs/PUBLISHING.md) for more details about release types.
See [PUBLISHING](/docs/PUBLISHING.md) for more details about release types.
Loading