aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Schlömer <nico.schloemer@gmail.com>2020-07-20 11:24:56 +0200
committerNico Schlömer <nico.schloemer@gmail.com>2020-07-20 11:24:56 +0200
commit92cbfa1c3792f9c9b78ea0077961f1bfde0a7037 (patch)
tree6c01b44a8bc3971d425a2e23d4fa005b52935e01
parent457d5bfda7e2d2f95c7ca40ad9be4e2b2e3cc36d (diff)
downloadautotiling-92cbfa1c3792f9c9b78ea0077961f1bfde0a7037.tar.gz
readme
-rw-r--r--README.md38
1 files changed, 23 insertions, 15 deletions
diff --git a/README.md b/README.md
index 77648fc..6d35f0f 100644
--- a/README.md
+++ b/README.md
@@ -10,26 +10,34 @@ Inspired by https://github.com/olemartinorg/i3-alternating-layout
## Installation
-[![Packaging status](https://repology.org/badge/vertical-allrepos/autotiling.svg)](https://repology.org/project/autotiling/versions)
+1. Install autotiling. Possible methods:
-**Arch Linux**
+ * 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).
-1. Install the `autotiling` (AUR) package.
-2. Add `exec autotiling` to the `~/.config/sway/config` or `exec_always --no-startup-id autotiling`
-to the `~/.config/i3/config` file.
-For the sway-git package use [autotiling-git](https://aur.archlinux.org/packages/autotiling-git).
+ * Arch Linux
+ [![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).
-NOTE: 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).
+ * _Manually_
-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.
+ 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_
+ ```
+ 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.
-`snap install autotiling`