aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/README.md b/README.md
index 12bbe89..4fd6c43 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,26 @@
# autotiling
-Script for sway and i3 to automatically switch the horizontal / vertical window split orientation
+This script uses the [i3ipc-python library](https://github.com/altdesktop/i3ipc-python) to switch the layout
+splith / splitv depending on the currently focused window dimensions. It works on both sway and i3 window managers.
+
+Inspired by https://github.com/olemartinorg/i3-alternating-layout
+
+## See on YouTube:
+
+[![Auto-tiling in action](https://img.youtube.com/vi/UWRZuhn92bQ/0.jpg)](https://www.youtube.com/watch?v=UWRZuhn92bQ)
+
+## Installation
+
+**Arch Linux**
+
+1. Install the `autotiling` (AUR) package.
+2. Add `exec autotiling` to the `~/.config/sway/config` or `exec --no-startup-id autotiling`
+to the `~/.config/i3/config` file. **Do not** use `exec_always`.
+
+
+**Manually**
+
+1. Install the `python-i3ipc` package (or whatever it's called in your Linux distribution).
+Remember to choose the python3 version.
+2. Save the `autotiling.py` file anywhere, make executable and autostart in your i3/sway config file:
+
+`exec /path/to/the/script/autotiling.py` on sway or `exec --no-startup-id /path/to/the/script/autotiling.py` on i3. \ No newline at end of file