Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nwg-piotr committed Nov 26, 2021
1 parent a488cc4 commit dbdbfa1
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ action](https://img.youtube.com/vi/UWRZuhn92bQ/0.jpg)](https://www.youtube.com/w

## 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 script does one thing: it checks the window 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.
Expand All @@ -26,21 +26,20 @@ For instance, you may configure autotiling to work on odd workspaces, but not on

## Installation

1. The script has been packaged for the following distributions:
The script has been packaged for the following distributions:

[![Packaging
status](https://repology.org/badge/vertical-allrepos/autotiling.svg)](https://repology.org/project/autotiling/versions)
[![Packaging
status](https://repology.org/badge/vertical-allrepos/autotiling.svg)](https://repology.org/project/autotiling/versions)

On Arch Linux for the latest development version you may use
[autotiling-git](https://aur.archlinux.org/packages/autotiling-git).
On Arch Linux for the latest development version you may use
[autotiling-git](https://aur.archlinux.org/packages/autotiling-git).

* _Manually_
Installing manually:

1. Install the `python-i3ipc>=2.0.1` package (or whatever it's called in your Linux
distribution);
2. save the `main.py` file anywhere, rename to `autotiling`, make executable, move to your bin folder.

2. Add `exec_always autotiling` to the `~/.config/sway/config` or `exec_always --no-startup-id
1. Install the `python-i3ipc>=2.0.1` package (or whatever it's called in your Linux
distribution);
2. save the `main.py` file anywhere, rename to `autotiling`, make executable, move to your bin folder;
3. add `exec_always autotiling` to the `~/.config/sway/config` or `exec_always --no-startup-id
autotiling` to the `~/.config/i3/config` file.

## Usage
Expand All @@ -64,4 +63,6 @@ optional arguments:

Changing event subscription has already been the objective of several pull request. To avoid doing this again and again,
starting from v1.6 you may specify them in the `-e` | `--events` argument. If no value given, the script will subscribe
to `Event.WINDOW` and `Event.MODE`, as if it was executed with `autotiling -e WINDOW MODE`.
to `Event.WINDOW` and `Event.MODE`, as if it was executed with `autotiling -e WINDOW MODE`. See
[altdesktop/i3ipc-python`](https://github.com/altdesktop/i3ipc-python/blob/a670f24e7e04f509de8161cf760afe929c22ae93/i3ipc/events.py#L12)
for event enumeration.

0 comments on commit dbdbfa1

Please sign in to comment.