summaryrefslogtreecommitdiff
path: root/doxygen/Mainpage.dox
diff options
context:
space:
mode:
authorJari Vetoniemi <mailroxas@gmail.com>2014-04-10 15:48:55 +0300
committerJari Vetoniemi <mailroxas@gmail.com>2014-04-10 15:48:55 +0300
commit4a931c5ed4aaa0637bd9d41f7e45e9f22d9513ce (patch)
tree4261f18e85636dfadaf0d1f36d762352c9812f31 /doxygen/Mainpage.dox
parent78713f23ac61f65a970b2870534327009213790b (diff)
downloadbemenu-4a931c5ed4aaa0637bd9d41f7e45e9f22d9513ce.tar.gz
bemenu-4a931c5ed4aaa0637bd9d41f7e45e9f22d9513ce.tar.bz2
bemenu-4a931c5ed4aaa0637bd9d41f7e45e9f22d9513ce.zip
Nicer doxygen output
Diffstat (limited to 'doxygen/Mainpage.dox')
-rw-r--r--doxygen/Mainpage.dox19
1 files changed, 19 insertions, 0 deletions
diff --git a/doxygen/Mainpage.dox b/doxygen/Mainpage.dox
new file mode 100644
index 0000000..8da4792
--- /dev/null
+++ b/doxygen/Mainpage.dox
@@ -0,0 +1,19 @@
+/**
+@mainpage Main Page
+
+bemenu is a dynamic menu library and client program inspired by dmenu.
+You can create flexible menu oriented programs using the library interface in your favorite language that has bemenu bindings avaialable.
+
+Unlike old dmenu approach, with library you don't have to feed unneccessary metadata into client program and parse the result.
+Instead your program will be aware of the items and possible metadata inside the menu.
+It's also possible to use multiple menus or dynamically remove/insert items.
+
+Features:
+ - Multiple layouts
+ - Different filtering algorithms:
+ - Vanilla dmenu filtering
+ - Rendering backends (UI toolkits are loaded dynamically, not depended):
+ - Curses
+
+bemenu also provides 'bemenu' executable that is compatible with dmenu interface.
+*/