X-Git-Url: https://git.subgeniuskitty.com/xmenu/.git/blobdiff_plain/47f3bbaf3cabf5a9612a78525682b53e08121aa2..70063f16f5da4e9eef33d369a41d7a0365ca11fa:/README.md?ds=sidebyside
diff --git a/README.md b/README.md
index 8c48534..cb61792 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,19 @@
-
-
+
+
# 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.
XMenu can be controlled both via mouse and via keyboard. The menu is a
pop-up menu (that is, after selecting an option, the menu disappears).
+In order to generate a menu of applications based on .desktop entries,
+as specified by XDG, checkout [xdg-xmenu](https://github.com/OliverLew/xdg-xmenu)
+by [OliverLew](https://github.com/OliverLew).
+
Check out my other project, [xclickroot](https://github.com/phillbush/xclickroot) for an application that can
spawn xmenu by right clicking on the root window (i.e. on the desktop).
@@ -17,17 +21,19 @@ spawn xmenu by right clicking on the root window (i.e. on the desktop).
## Features
XMenu comes with the following features:
-⢠XMenu reads something in and prints something out, the UNIX way.
-⢠Submenus (some menu entries can spawn another menu).
-⢠Separators (menu entries can be separated by a line).
-⢠Icons (menu entries can be preceded by an icon image).
+
+* XMenu reads something in and prints something out, the UNIX way.
+* Submenus (some menu entries can spawn another menu).
+* 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).
## Files
The files are:
-* `./README`: This file.
+* `./README`: This file.
* `./Makefile`: The makefile.
* `./config.h`: The hardcoded default configuration for XMenu.
* `./config.mk`: The setup for the makefile.
@@ -66,10 +72,10 @@ Each line is made out of a label and a command separated by any number
of tabs. Lines without labels are menu separators.
See the script `./xmenu.sh` for an example of how to use XMenu to draw a
-simple menu with submenus and separators. The file ./demo.gif shows how
+simple menu with submenus and separators. The file `./demo.gif` shows how
the menu generated by that script looks like.
-Read the manual for more information on running XMenu.
+Read the [manual](https://github.com/phillbush/xmenu/wiki) for more information on running XMenu.
## License