aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorNico Schlömer <nico.schloemer@gmail.com>2020-07-20 11:33:44 +0200
committerNico Schlömer <nico.schloemer@gmail.com>2020-07-20 11:33:44 +0200
commit92f2ef42c4d923cd31d6ac6e77b6f5efb89b4e4b (patch)
treeed02011dea68a2aba5a09c517cfe0d1272971a1a /README.md
parent27d235511173ac0f360c213b3062d75de4bc6533 (diff)
downloadautotiling-92f2ef42c4d923cd31d6ac6e77b6f5efb89b4e4b.tar.gz
more readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 30 insertions, 23 deletions
diff --git a/README.md b/README.md
index 53c247a..28bf3ac 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,49 @@
# autotiling
-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.
+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
+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)
+[![Auto-tiling in
+action](https://img.youtube.com/vi/UWRZuhn92bQ/0.jpg)](https://www.youtube.com/watch?v=UWRZuhn92bQ)
## Installation
1. Install autotiling. Possible methods:
- * PyPi._ autotiling is available from PyPi, so you can install it with
- ```
- pip install autotiling
- ```
- _NOTE:_ The current master branch is compatible with sway >= 1.5. For lower versions
- you need to use the script from the [sway14
- branch](https://github.com/nwg-piotr/autotiling/tree/sway14) or the [0.9
- release](https://github.com/nwg-piotr/autotiling/releases/tag/v0.9).
+ * _PyPi._ autotiling is available from PyPi, so you can install it with
+ ```
+ pip install autotiling
+ ```
+ _NOTE:_ The current master branch is compatible with sway >= 1.5. For lower
+ versions you need to use the script from the [sway14
+ branch](https://github.com/nwg-piotr/autotiling/tree/sway14) or the [0.9
+ release](https://github.com/nwg-piotr/autotiling/releases/tag/v0.9).
- * _Arch Linux_
- [![Packaging status](https://repology.org/badge/vertical-allrepos/autotiling.svg)](https://repology.org/project/autotiling/versions)
+ * _Arch Linux_
- For the sway-git package use [autotiling-git](https://aur.archlinux.org/packages/autotiling-git).
+ [![Packaging
+ status](https://repology.org/badge/vertical-allrepos/autotiling.svg)](https://repology.org/project/autotiling/versions)
- * _Manually_
+ For the sway-git package use
+ [autotiling-git](https://aur.archlinux.org/packages/autotiling-git).
- 1. Install the `python-i3ipc>=2.0.1` package (or whatever it's called in your Linux distribution).
- 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_always --no-startup-id /path/to/the/script/autotiling.py` on i3.
+ * _Manually_
- * _Snap_
- ```
- snap install autotiling
- ```
+ 1. Install the `python-i3ipc>=2.0.1` package (or whatever it's called in your Linux
+ distribution).
+ 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_always --no-startup-id /path/to/the/script/autotiling.py` on i3.
+
+ * _Snap_
+ ```
+ snap install autotiling
+ ```
2. Add `exec autotiling` to the `~/.config/sway/config` or `exec_always --no-startup-id
autotiling` to the `~/.config/i3/config` file.