diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/README.md b/README.md index 271ffa3689a2..c730e348e155 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ # i3-auto-arrange -A Shell script that automatically rearranges i3 workspaces in order to get rid of gaps in ordering +This tool is designed to help you when you have many workspaces open in `i3`, and when you close some of them you end up with gaps in the numbering. Instead of arranging them one by one, you can run `i3-auto-arrange` and it will automatically do it for you. + +### Installation +You can find this script as a package on the AUR (Arch User Repository): https://aur.archlinux.org/packages/i3-auto-arrange + +Using a package helper such as `yay`, you could run `yay -S i3-auto-arrange` + +Or, to install from source instead: +``` +$ git clone https://github.com/denis-ismailaj/i3-auto-arrange.git +$ cd i3-auto-arrange +$ makepkg +``` +### Dependencies +- `i3-wm` (obviously) +- `jq` (needed to parse output from `i3-msg`) |