summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8fb594
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Luke's dmenu
+
+Extra stuff added to vanilla dmenu:
+
+- reads Xresources (ergo pywal compatible)
+- alpha patch, which importantly allows this build to be embedded in transparent st
+- can view color characters like emoji (libxft-bgra is required for this reason)
+- `-P` for password mode: hide user input
+- `-r` to reject non-matching input
+- dmenu options are mouse clickable
+
+## Installation
+
+You must have `libxft-bgra` installed until the libxft upstream is fixed.
+
+After making any config changes that you want, but `make`, `sudo make install` it.