computing textwidth with the function drawtext
[xmenu] / README
diff --git a/README b/README
index 5e2e226..0004d5d 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
@@ -22,21 +32,14 @@ The files are:
 • ./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.
-
-
-§ Branches
-
-There are other branches in this git repository that adds novel
-functionalities to XMenu.
-
-• icons:    Add suport to image icons before menu entries.
+• ./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
@@ -68,4 +71,24 @@ Read the manual for more information on running XMenu.
 
 § License
 
 
 § License
 
-This software is in public domain and is provided AS IS, with NO WARRANTY.
+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.
+
+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.