aboutsummarylogtreecommitdiffstats
diff options
context:
space:
mode:
authorgashon2024-12-29 19:18:15 -0800
committergashon2024-12-29 19:18:15 -0800
commitfd52652d3bc7047456a36308c9d7f8507a9eff7a (patch)
tree6f622bdb907153f9e7b6c94a344d32e54de05712
parentd566814d8a8fd507b51ee9858f4ea4143b9159eb (diff)
downloadaur-fd52652d3bc7047456a36308c9d7f8507a9eff7a.tar.gz
chore: init readme
-rw-r--r--README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..e9e8c751cba9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+# i3-lru
+
+A lightweight i3 window switcher based on LRU (Last Recently Used) order.
+
+## Features
+
+- **i3-lru-daemon**: Tracks window focus events to maintain LRU order.
+- **i3-lru**: Displays a rofi menu for fast window switching.
+
+## Requirements
+
+- [rofi](https://github.com/davatorium/rofi)
+- jq
+- i3-wm (or compatible window manager)
+
+## Installation
+
+Install from the AUR:
+```
+yay -S i3-lru
+```
+
+## Usage
+
+1. Start the daemon:
+ ```
+ i3-lru-daemon &
+ ```
+ (Optional: Use a systemd user service for auto-start.)
+
+2. Open the switcher:
+ ```
+ i3-lru
+ ```
+
+Press **Tab** and **Enter** to quickly toggle between recent windows.
+
+## License
+
+MIT