summaryrefslogtreecommitdiff
path: root/gui-libs/wf-overview/files/README.gentoo
blob: 1e79b57bcc40ccd423f120d4ce5c45006406904a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
wf-overview for the personal Gentoo overlay
==========================================

Source: https://github.com/okcomput3/wf-overview
Pinned commit: 240721d3d84c303ab29aeb674d0e84802f69ad80
Upstream commit date: 2026-02-28
Package version: 0.1.0_p20260228 (snapshot, not an upstream release)
License: MIT

This package targets the personal Wayfire 0.11 branch with wlroots 0.20
and floating-point scene damage. It has not been qualified against the
older public SrcUX overlay or stock Wayfire 0.11.

Downstream changes
------------------
1. Port scene damage/visibility callbacks to the installed regionf_t API,
   fix float clamping with floating-point geometry, and use the current
   output lookup API.
2. Add overview/show_panel, disabled by default, so wf-shell can retain
   its panel. Set it to true to try the upstream Activities/clock panel.
3. Default the shortcut to Super+Ctrl+O and leave wallpaper unset, rather
   than binding bare Super and referring to the upstream author's home.
4. Subscribe to output lifecycle events on output_layout, their actual
   signal provider. Upstream subscribed on core, leaving stale instances
   after outputs disappeared and crashing during plugin unload on the
   stitched desktop. Disconnect callbacks before teardown.

Activation
----------
Add overview to your existing [core] plugins list. Merge examples/overview.ini
into your own configuration. The plugin name and configuration section are
overview; the upstream README still uses the older gnome-shell name.

Installation alone does not enable the plugin or change desktop settings.
Disabling overview in the plugin list returns to the existing desktop.

Qualification limits
--------------------
The upstream interface is a prototype. It observes pointer buttons after
client delivery, does not explicitly focus the selected window, and listens
only for relative pointer motion. Input ownership, window selection,
absolute-pointer handling, keyboard navigation, interactions with screen
locking, and dynamic output/window changes need work before this becomes
a default SrcUX feature. The optional panel does not reserve work area.

The normal snapped/floating layout is represented by visual transformers
during overview; this package adds no automatic tiling policy.

Local build and private-session results are recorded in:
/root/projects/wf-overview-packaging-20261009/README.md