summaryrefslogtreecommitdiff
path: root/doxygen/Mainpage.dox
diff options
context:
space:
mode:
authorJari Vetoniemi <mailroxas@gmail.com>2014-08-21 01:47:30 +0300
committerJari Vetoniemi <mailroxas@gmail.com>2014-08-21 01:47:30 +0300
commitf1bb87a808ff1383a2d27dc2c4a1f8812c470c31 (patch)
tree6669801544e51621c9269e5e89d3ae7a83c73ba8 /doxygen/Mainpage.dox
parent5bd81e8d384e82926a7671527e62aebafed1183f (diff)
parent536eee6d0bf8eb99b6566f7f4fd646b3cd76f532 (diff)
downloadbemenu-f1bb87a808ff1383a2d27dc2c4a1f8812c470c31.tar.gz
bemenu-f1bb87a808ff1383a2d27dc2c4a1f8812c470c31.tar.bz2
bemenu-f1bb87a808ff1383a2d27dc2c4a1f8812c470c31.zip
Merge branch 'develop'
Diffstat (limited to 'doxygen/Mainpage.dox')
-rw-r--r--doxygen/Mainpage.dox21
1 files changed, 21 insertions, 0 deletions
diff --git a/doxygen/Mainpage.dox b/doxygen/Mainpage.dox
new file mode 100644
index 0000000..1b91ebf
--- /dev/null
+++ b/doxygen/Mainpage.dox
@@ -0,0 +1,21 @@
+/**
+@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 available.
+
+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.
+
+Get started on the <a href="modules.html">Modules</a> page.
+*/