Improved README

diff --git a/LICENSE b/LICENSE
deleted file mode 100644 (file)
index fdddb29..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,24 +0,0 @@
-This is free and unencumbered software released into the public domain.
-
-Anyone is free to copy, modify, publish, use, compile, sell, or
-distribute this software, either in source code form or as a compiled
-binary, for any purpose, commercial or non-commercial, and by any
-means.
-
-In jurisdictions that recognize copyright laws, the author or authors
-of this software dedicate any and all copyright interest in the
-software to the public domain. We make this dedication for the benefit
-of the public at large and to the detriment of our heirs and
-successors. We intend this dedication to be an overt act of
-relinquishment in perpetuity of all present and future rights to this
-software under copyright law.
-
-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 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.
-
-For more information, please refer to <https://unlicense.org>

diff --git a/README b/README
index ca341d2..e3867c6 100644 (file)
--- a/README
+++ b/README
@@ -1,32 +1,64 @@
-                                 xmenu
+                                 XMenu

 
 

-Xmenu is a menu utility for X.
-Xmenu receives a menu specification in stdin, shows a menu for the user
+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.
 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).
+
+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.
+
+
+§ Files
+
+The files are:
+• ./README:     This file.
+• ./Makefile:   The makefile.
+• ./config.h:   The hardcoded default configuration for XMenu.
+• ./config.mk:  The setup for the makefile.
+• ./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.

 
 

-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
 
 
 § Installation
 

-In order to build xmenu you need the Xlib header files.
+First, edit ./config.mk to match your local setup.
+
+In order to build XMenu you need the Xlib and the 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
+creates the binary file ./xmenu.

 
 

-Edit config.mk to match your local setup (xmenu is installed into the
-/usr/local prefix by default).  Then enter the following command to
-build and install xmenu (if necessary as root).
+       make

 
 

-       make clean install
+By default, XMenu is installed into the /usr/local prefix.  Enter the
+following command to install XMenu (if necessary as root).  This command
+installs the binary file ./xmenu into the ${PREFIX}/bin/ directory, and
+the manual file ./xmenu.1 into ${MANPREFIX}/man1/ directory.

 
 

+       make install

 
 

-§ Running xmenu

 
 

-xmenu receives as input a menu specification where each line is a menu
+§ Running XMenu
+
+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.  Lines without labels are menu separators.
 
 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.
 

-See the script ./xmenu.sh for an example of how xmenu can be used to
-draw a simple menu with submenus and 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
+
+Read the manual for more information on running XMenu.
+
+
+§ License

 
 

-Read the manual for more information on running xmenu.
+This software is in public domain and is provided AS IS, with NO WARRANTY.

diff --git a/xmenu.sh b/xmenu.sh
index ff145d4..abd9a41 100755 (executable)
--- a/xmenu.sh
+++ b/xmenu.sh
@@ -1,8 +1,5 @@
 #!/bin/sh
 
 #!/bin/sh
 

-# ignore hup signal
-trap "" 1 15
-

 cat <<EOF | xmenu | sh &
 Applications
        Web Browser     firefox
 cat <<EOF | xmenu | sh &
 Applications
        Web Browser     firefox