Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
emvaized authored Aug 17, 2022
1 parent 8dce699 commit 84ec5fe
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,19 @@ You can select the window with mouse, as well as with arrow keys + `Enter`.
To dismiss the assist, hit `Escape` key, press the close button or click anywhere on the empty area.
Script also supports quarter and triple tiling: you can switch layouts with the `Tab` key or using the button in corner.

Since version 1.4, it also provides experimental options for *enhanced* snapped windows management:
Since version `1.4`, there are now experimental options for *enhanced* snapped windows management:
- Minimize/restore snapped windows together
- Raise snapped windows together
- On close snapped window, try to fill the area

Few notes:
- To apply new settings, you may need to re-enable the script or restart KWin
- Assist will not show if you have no other windows matching the conditions set in the script settings
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.

Ideas, suggestions, bugs reports and contributions are welcome!

[KDE Store](https://store.kde.org/p/1875687)

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


---
### Manual Installation
In order to install this script manually from GitHub, you'd need to:
Expand All @@ -31,14 +28,28 @@ In order to install this script manually from GitHub, you'd need to:
- Re-login to Plasma again (or restart KWin) to make sure the script is installed

---
### Troubleshooting
- 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
- 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.

---
### Compatibility notes

### Compatibility with [Window Gap](https://github.com/nclarius/tile-gaps) script
#### Compatibility with [Window Gap](https://github.com/nclarius/tile-gaps)

Since version 1.2, there's an option "Snap detect tolerance" in the script settings, which basically defines how much window's size and position can differ to still be detected as "snapped" by the script. If you use some external scripts which constantly modify windows size and position, you may want to set it to `15px` or `25px`, so that Snap Assist could detect your snaps.

### Compatibility with diagonal keyboard shortcuts
#### Compatibility with [Exquisite](https://www.pling.com/p/1852610)

Most of default layouts are supported out the box. You may also like to enable "Hide after tiling a window" in Exquisite's settings for the smoothest workflow. Over time, support for custom layouts will expand, possibly with ability to edit them.

#### Compatibility with [Sticky Window Snapping](https://www.pling.com/p/1112552)

Fully compatible. Highly recommended to be used in conjunction with Snap Assist.

#### Compatibility with diagonal keyboard shortcuts

Version 1.4 introduces an option "Delay before showing the assist", which gives some time to execute 'diagonal' shortcuts (`super` + `` + ``) before Assist gets shown.
Version 1.4 introduces an option "Delay before showing the assist", which gives some time to execute 'diagonal' shortcuts (`super` + `` + ``) before Assist gets shown. The default value is `100ms`.

---

Expand Down

0 comments on commit 84ec5fe

Please sign in to comment.