added the -i option

[xmenu] / README

diff --git a/README b/README
index e3867c6..290ef37 100644 (file)
--- a/README
+++ b/README
@@ -6,9 +6,19 @@ 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).
 
 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).
 

-NOTE:
-The -w (windowed) option was removed from the master branch.  It was too
-buggy in tiled window managers and required more code to be maintained.
+Check out my other project, xclickroot[0] for an application that can
+spawn xmenu by right clicking on the root window (i.e. on the desktop).
+
+[0]: https://github.com/phillbush/xclickroot
+
+
+§ 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).

 
 
 § Files
 
 
 § Files


@@ -18,16 +28,18 @@ The files are:
 • ./Makefile:   The makefile.
 • ./config.h:   The hardcoded default configuration for XMenu.
 • ./config.mk:  The setup for the makefile.
 • ./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.
 • ./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.

+• ./icons/:     Icons for the sample script

 
 
 § Installation
 
 First, edit ./config.mk to match your local setup.
 
 
 
 § Installation
 
 First, edit ./config.mk to match your local setup.
 

-In order to build XMenu you need the Xlib and the Xft header files.
+In order to build XMenu you need the Imlib2, Xlib 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
 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


@@ -50,11 +62,9 @@ entry.  Each line can be indented with tabs to represent nested menus.
 Each line is made out of a label and a command separated by any number
 of tabs.  Lines without labels are menu separators.
 
 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 XMenu can be used to
-draw a simple menu with submenus and separators.   The following gif
-shows how the menu generated by that script looks like.
-
-       https://i.redd.it/lxv7jewcwmz41.gif
+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
+the menu generated by that script looks like.

 
 Read the manual for more information on running XMenu.
 
 
 Read the manual for more information on running XMenu.