aboutsummarylogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authordenis-ismailaj2024-03-24 12:02:08 +0100
committerdenis-ismailaj2024-03-24 12:13:39 +0100
commitb3ac1e76d9c172ab1f1d7a903e02da3eaad076ee (patch)
tree2de3ab791f05c77719d6044f66bcf777fcb2ba5e /README.md
parente0c88744554a8c24f2c69344e08558b3a59c84be (diff)
downloadaur-b3ac1e76d9c172ab1f1d7a903e02da3eaad076ee.tar.gz
Update package
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 29 insertions, 10 deletions
diff --git a/README.md b/README.md
index c730e348e155..a23408e4ee96 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,36 @@
# i3-auto-arrange
-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.
+
+Opening and closing many workspaces in `i3` can lead to gaps in numbering.
+
+Instead of rearranging them yourself, you can have `i3-auto-arrange` 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`
+This script is available as an [AUR package](https://aur.archlinux.org/packages/i3-auto-arrange).
+
+You can use an AUR helper such as `yay` to install it:
+
+ yay -S i3-auto-arrange
-Or, to install from source instead:
+Or, to install from source:
```
-$ git clone https://github.com/denis-ismailaj/i3-auto-arrange.git
-$ cd i3-auto-arrange
-$ makepkg
+git clone https://github.com/denis-ismailaj/i3-auto-arrange.git
+cd i3-auto-arrange
+makepkg
+sudo pacman -U i3-auto-arrange-*.pkg.tar.xz
```
-### Dependencies
-- `i3-wm` (obviously)
-- `jq` (needed to parse output from `i3-msg`)
+
+> [!NOTE]
+> `i3-auto-arrange` depends on `jq` in order to parse the outputs of `i3-msg`
+
+### Usage
+
+`i3-auto-arrange` is most useful when used as a keyboard shortcut.
+
+To do that, open your `i3` config file:
+
+ vim ~/.config/i3/config # or ~/.i3/config
+
+and bind your preferred key combination to running `i3-auto-arrange`:
+
+ bindsym <key combination> exec i3-auto-arrange