Skip to content

Commit

Permalink
add info about compositor requirement to README
Browse files Browse the repository at this point in the history
  • Loading branch information
coderedart committed Nov 7, 2024
1 parent a87f02b commit 5801821
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,10 @@ https://github.com/coderedart/egui_overlay/assets/24411704/9f7bab7b-26ec-47d1-b5

## Platforms
1. Windows
2. Linux (both X11 and Wayland). But support might vary between different window managers.
2. Linux
1. X11 supported natively. And wayland can work via Xwayland. But support might vary between window managers.
2. You need a compositor that supports transparency. eg: `kwin` supports compositing, but `i3wm` needs an external compositor like `picom`.
3. Some tiling window managers like i3wm need users to configure your overlay window as "floating" to keep it above other tiled windows.
3. Mac

## Bugs
Expand Down

0 comments on commit 5801821

Please sign in to comment.