X-Git-Url: https://git.subgeniuskitty.com/xmenu/.git/blobdiff_plain/883ec17fe267ad3c59f15f0623911dfcdd9f2912..HEAD:/README.md diff --git a/README.md b/README.md index d81aa39..0dd2597 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,3 @@ -

- -

- # XMenu XMenu is a menu utility for X. @@ -26,6 +22,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 +33,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 +43,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 @@ -77,26 +73,10 @@ the menu generated by that script looks like. Read the [manual](https://github.com/phillbush/xmenu/wiki) for more information on running XMenu. -## License - -MIT/X Consortium License - -© 2020 phillbush - -Permission is hereby granted, free of charge, to any person obtaining a -copy of this software and associated documentation files (the "Software"), -to deal in the Software without restriction, including without limitation -the rights to use, copy, modify, merge, publish, distribute, sublicense, -and/or sell copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. +## Acknowledgements -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER -DEALINGS IN THE SOFTWARE. +* [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.