Skip to content

Commit 28caf78

Browse files
authored
Update README.md
1 parent 84ec5fe commit 28caf78

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# <sub><img src="https://github.com/emvaized/kde-snap-assist/blob/dev/assets/logo.png" height="48" width="48"></sub> KDE Snap Assist
2+
[KDE Store](https://store.kde.org/p/1875687)
3+
24
This KWin script for KDE Plasma suggests other window thumbnails on snap. It tries to replicate the famous Windows 10/11 feature of the same name.
35

46
Assist can be shown by dragging a window to the screen edge, as well as via default keyboard shortcuts (`super`+arrows).
@@ -11,11 +13,10 @@ Since version `1.4`, there are now experimental options for *enhanced* snapped w
1113
- Raise snapped windows together
1214
- On close snapped window, try to fill the area
1315

14-
When you enable any of these options in settings, the script will start tracking windows snapped with the script. Group of snapped windows is remembered once you fill the layout using the assist. Window is no longer considered snapped once it was closed or moved manually using the mouse.
16+
When you enable any of these options in settings, the script will start tracking windows snapped with the script. Group of snapped windows is remembered once you fill the layout using the assist. Window is no longer considered snapped once it was closed or moved manually using the mouse.
17+
Snap groups are not persistent, and likely will be needed to recreate on each reboot.
1518

16-
Ideas, suggestions, bugs reports and contributions are welcome!
17-
18-
[KDE Store](https://store.kde.org/p/1875687)
19+
Ideas, suggestions, bugs reports and contributions to the project are welcome!
1920

2021
![screenshot_snapassist](https://user-images.githubusercontent.com/37851576/183264649-da8d01cd-a8b7-4bac-92d7-ea71be00047d.png)
2122

@@ -30,7 +31,8 @@ In order to install this script manually from GitHub, you'd need to:
3031
---
3132
### Troubleshooting
3233
- To apply the new settings, you may need to re-enable the script or restart KWin. The same is recommended if you switch from one version of the script to another
33-
- Assist will not show if you have no other windows matching the conditions set in the script settings. For example, by default the script does not show windows from other screens — so, if you have only one window on the current screen, assist will not show.
34+
- Assist will not show if you have no other windows matching the conditions set in the script settings. For example, by default the script does not show windows from other screens — so, if you have only one window on the current screen, assist will not show
35+
- Script settings button is not visible, or complains that "Plugin doesn't provide configuration file in the expected location" — this is a known KWin's bug, not related to the script. Make sure your system is up-to-date, as it seems to be fixed now. If it doesn't help, you can also try to install the script [manually](https://github.com/emvaized/kde-snap-assist#manual-installation).
3436

3537
---
3638
### Compatibility notes
@@ -54,6 +56,6 @@ Version 1.4 introduces an option "Delay before showing the assist", which gives
5456
---
5557

5658
### Donate
57-
If you really like this script, you can thank for it by buying me a coffee :)
59+
If you **really** like this script, you can always thank for it by buying me a coffee :)
5860

5961
<a href="https://www.paypal.com/donate/?business=2KDNGXNUVZW7N&no_recurring=0&currency_code=USD"><img src="https://www.paypalobjects.com/en_US/DK/i/btn/btn_donateCC_LG.gif" height="25"/></a>

0 commit comments

Comments
 (0)