aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoradnano <me@adnano.co>2022-01-16 08:32:58 -0500
committeradnano <me@adnano.co>2022-01-16 08:32:58 -0500
commit2f1c189d535c2d8dce74ec44c670305f00e4a30c (patch)
tree79811ea0ebe16d28b4bd7bfe2cff1db1977919db /README.md
downloadwmenu-2f1c189d535c2d8dce74ec44c670305f00e4a30c.tar.gz
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8ec32e6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# wmenu - dmenu for Wayland
+
+An efficient dynamic menu for supported Wayland compositors (requires
+`wlr_layer_shell_v1` support).
+
+## Installation
+
+Dependencies:
+
+- cairo
+- pango
+- wayland
+- xkbcommon
+- scdoc (optional)
+
+```
+$ meson build
+$ ninja -C build
+# ninja -C build install
+```
+
+## Usage
+
+See wmenu(1)
+
+## Credits
+
+This project started as a fork of [dmenu-wl](https://github.com/nyyManni/dmenu-wayland).
+However, most of the code was rewritten from scratch.