prepare stuff for type-to-select

[xmenu] / README.md

diff --git a/README.md b/README.md
index 8c48534..838607b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,17 @@
 <p align="center">
   <img src="/demo.gif", title="demo"/>
 <p align="center">
   <img src="/demo.gif", title="demo"/>

-</p>            
-                                 
+</p>
+

 # XMenu
 # 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 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).
+XMenu can be controlled both via mouse and via keyboard.
+
+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).
 
 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 +20,19 @@ spawn xmenu by right clicking on the root window (i.e. on the desktop).
 ## Features
 
 XMenu comes with the following features:
 ## 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:
 
 
 
 ## 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.
 * `./Makefile`:   The makefile.
 * `./config.h`:   The hardcoded default configuration for XMenu.
 * `./config.mk`:  The setup for the makefile.


@@ -66,32 +71,7 @@ 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
 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.
 
 the menu generated by that script looks like.
 

-Read the manual for more information on running XMenu.
-
-
-## License
-
-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.
+Read the [manual](https://github.com/phillbush/xmenu/wiki) for more information on running XMenu.