summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJari Vetoniemi <mailRoxas@gmail.com>2019-03-25 10:52:24 +0200
committerGitHub <noreply@github.com>2019-03-25 10:52:24 +0200
commitb375ef8b0bd2c40b4fc26bd0c4d38dcb4374c149 (patch)
treebb8fb87db0be7f207c98dbb79a44b4955fccf6f6 /README.md
parent1be74a290f7ef9a0cc420ad98239c2f7dbb03165 (diff)
parent5ca32626dc603dfddcf833c762174b4260b8af2c (diff)
downloadbemenu-b375ef8b0bd2c40b4fc26bd0c4d38dcb4374c149.tar.gz
bemenu-b375ef8b0bd2c40b4fc26bd0c4d38dcb4374c149.tar.bz2
bemenu-b375ef8b0bd2c40b4fc26bd0c4d38dcb4374c149.zip
Merge pull request #46 from DanySpin97/master
Add options for renderers, make deps required
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 35af368..3bd2c56 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,20 @@ bemenu
Dynamic menu library and client program inspired by dmenu
+## Renderers
+
+bemenu supports three different renderers:
+
+- ncurses
+- X11
+- Wayland
+
+Enable/disable the renderers by appending these CMake options when executing `cmake <dir>`:
+
+- `-DBEMENU_CURSES_RENDERER=[OFF|ON]`
+- `-DBEMENU_X11_RENDERER=[OFF|ON]`
+- `-DBEMENU_WAYLAND_RENDERER=[OFF|ON]`
+
## License
* [GNU GPLv3 (or any later version)](LICENSE-CLIENT) for client program[s] and
other sources except library and bindings