X-Git-Url: https://git.subgeniuskitty.com/xmenu/.git/blobdiff_plain/59a8a9505694034a1eae39019ba26181a6176367..15fadd8840d0e92415b66133e73a0197957c1139:/README.md
diff --git a/README.md b/README.md
index 838607b..ac2542b 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,9 @@
+# XMenu
+
-
+
-# XMenu
-
XMenu is a menu utility for X.
XMenu receives a menu specification in stdin, shows a menu for the user
to select one of the options, and outputs the option selected to stdout.
@@ -26,6 +26,8 @@ XMenu comes with the following features:
* Separators (menu entries can be separated by a line).
* Icons (menu entries can be preceded by an icon image).
* X resources support (you don't need to recompile xmenu for configuring it).
+* Multi-head (xmenu supports multiple monitors by using Xinerama).
+* Type-to-select (you can select an item by typing part of its name).
## Files
@@ -35,8 +37,6 @@ The files are:
* `./README`: This file.
* `./Makefile`: The makefile.
* `./config.h`: The hardcoded default configuration for XMenu.
-* `./config.mk`: The setup for the makefile.
-* `./demo.gif`: A gif demonstrating how XMenu works.
* `./xmenu.1`: The manual file (man page) for XMenu.
* `./xmenu.c`: The source code of XMenu.
* `./xmenu.sh`: A sample script illustrating how to use XMenu.
@@ -47,7 +47,7 @@ The files are:
First, edit `./config.mk` to match your local setup.
-In order to build XMenu you need the `Imlib2`, `Xlib` and `Xft` header files.
+In order to build XMenu you need the `Imlib2`, `Xlib`, `Xinerama` and `Xft` header files.
The default configuration for XMenu is specified in the file `config.h`,
you can edit it, but most configuration can be changed at runtime via
X resources. Enter the following command to build XMenu. This command
@@ -75,3 +75,12 @@ simple menu with submenus and separators. The file `./demo.gif` shows how
the menu generated by that script looks like.
Read the [manual](https://github.com/phillbush/xmenu/wiki) for more information on running XMenu.
+
+
+## Acknowledgements
+
+* [thingmenu](https://github.com/singpolyma/thingmenu) for being the base
+ for xmenu's code. However, xmenu evolved enough that it no longer resembles
+ thingmenu at all.
+* [dmenu](https://tools.suckless.org/dmenu/) for inspiring the stdin-to-stdout
+ interface, and being base for drawing routines and input method code.