diff options
-rw-r--r-- | CHANGELOG.md | 6 | ||||
-rw-r--r-- | README.md | 29 |
2 files changed, 34 insertions, 1 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 8091e24..80f98fa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +v1.3 (2021-01-08) +- added `--workspaces` argument to restrict autotiling to certain workspaces @riscie +- code formatting and arguments cleanup + v1.2 (2021-01-04) - added --version argument @nschloe - allowed autotiling to be run as a script directly @Lqp1 @@ -9,7 +13,7 @@ v1.1 (2020-07-21) v1.0 (2020-07-19) - changed fullscreen mode detection to reflect changes in sway 1.5 [#11](https://github.com/nwg-piotr/autotiling/pull/11) @ammgws - +78 v0.9 (2020-04-08) - bug in debugging fixed [#6](https://github.com/nwg-piotr/autotiling/pull/6) @@ -10,6 +10,21 @@ Inspired by https://github.com/olemartinorg/i3-alternating-layout. [![Auto-tiling in action](https://img.youtube.com/vi/UWRZuhn92bQ/0.jpg)](https://www.youtube.com/watch?v=UWRZuhn92bQ) +## PLEASE DO READ THIS + +This script does one thing: when a window is being focused, it checks it's height / width ratio, and executes +the equivalent of either `swaymsg splitv` or `swaymsg splith`. Nothing less, nothing more. Yes, it may make +stacking and tabbed layouts behave oddly. No, nothing can be done about it. If you like stacking/tabbed layouts, +you may use them on workspaces with autotiling turned off (`--workspaces` argument). Do not submit issues about it. + +For instance, on my triple-headed setup (2 workspaces per output), I configured autotiling to work on odd +workspaces, but not on even: + +```text +### Autostart + exec autotiling -w 1 3 5 +``` + ## Installation 1. Install autotiling. Possible methods: @@ -53,3 +68,17 @@ action](https://img.youtube.com/vi/UWRZuhn92bQ/0.jpg)](https://www.youtube.com/w 2. Add `exec autotiling` to the `~/.config/sway/config` or `exec_always --no-startup-id autotiling` to the `~/.config/i3/config` file. + +## Usage + +```text +$ autotiling -h +usage: autotiling [-h] [-d] [-v] [-w [WORKSPACES ...]] + +optional arguments: + -h, --help show this help message and exit + -d, --debug Print debug messages to stderr + -v, --version display version information + -w [WORKSPACES ...], --workspaces [WORKSPACES ...] + Restricts autotiling to certain workspaces. Example: autotiling --workspaces 8 9 +```
\ No newline at end of file |