Refactored code, changed resources and config.h
[xmenu] / README
diff --git a/README b/README
index c289e23..ca341d2 100644 (file)
--- a/README
+++ b/README
@@ -4,17 +4,19 @@ 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 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.
 
+NOTE: The -w (windowed) option was removed from the master branch.
+      It was too buggy in tiled window managers and requires more
+      code to be maintained.
+
 § Installation
 
 In order to build xmenu you need the Xlib header files.
 
 § Installation
 
 In order to build xmenu you need the Xlib header files.
 
-Edit config.mk to match your local setub (dwm is installed into the
+Edit config.mk to match your local setup (xmenu is installed into the
 /usr/local prefix by default).  Then enter the following command to
 /usr/local prefix by default).  Then enter the following command to
-build and install dwm (if necessary as root).
+build and install xmenu (if necessary as root).
 
 
-┌─────────────────────────────────────────────────────────────────────┐
-│ make clean install                                                  │
-└─────────────────────────────────────────────────────────────────────┘
+       make clean install
 
 
 § Running xmenu
 
 
 § Running xmenu
@@ -22,5 +24,9 @@ build and install dwm (if necessary as root).
 xmenu receives as input a menu specification where each line is a menu
 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
 xmenu receives as input a menu specification where each line is a menu
 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.
+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.
 
 
+Read the manual for more information on running xmenu.