1 files changed, 32 insertions, 0 deletions
diff --git a/wmenu/README.md b/wmenu/README.md
new file mode 100755
index 0000000..62a34a7
--- /dev/null
+++ b/wmenu/README.md
@@ -0,0 +1,32 @@
+# wmenu
+
+wmenu is an efficient dynamic menu for Sway and wlroots based Wayland
+compositors. It provides a Wayland-native dmenu replacement which maintains the
+look and feel of dmenu.
+
+## Installation
+
+Dependencies:
+
+- cairo
+- pango
+- wayland
+- xkbcommon
+- scdoc (optional)
+
+```
+$ meson setup build
+$ ninja -C build
+# ninja -C build install
+```
+
+## Usage
+
+See wmenu(1)
+
+To use wmenu with Sway, you can add the following to your configuration file:
+
+```
+set $menu wmenu-run
+bindsym $mod+d exec $menu
+```