aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f45eaec
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# sway-launcher-desktop
+
+This is a launcher menu made for the Sway window manager made with bash and the amazing [fzf](https://github.com/junegunn/fzf).
+
+## Features
+- Lists and executes available binaries
+- Lists and executes .desktop files (entries as well as actions)
+- Shows a preview window containing `whatis` info of binaries and the `Comment=` section of .desktop files
+- History support which will highlight recently used entries. (Inspried by [this nice script which inspired me to create my own](https://gitlab.com/FlyingWombat/my-scripts/blob/master/sway-launcher))
+- Colored output and glyphs for the different entry types
+- Entries are lazily piped into fzf eliminating any lag during startup
+
+## Installation
+
+Make sure you have `fzf` installed and download this repository
+
+Configure it in Sway like this:
+```
+for_window [class="URxvt" instance="launcher"] floating enable, border pixel 10, sticky enable
+set $menu exec urxvt -geometry 55x18 -name launcher -e /path/to/repo/sway-launcher-desktop.sh
+bindsym $mod+d exec $menu
+```