Freeing fonts

[xmenu] / README.md

diff --git a/README.md b/README.md
index 23c3569..12ffb11 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,60 +1,61 @@
 <p align="center">
   <img src="/demo.gif", title="demo"/>
 </p>            
 <p align="center">
   <img src="/demo.gif", title="demo"/>
 </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 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 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).
 

-Check out my other project, xclickroot[0] for an application that can
+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).
 
 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:
 
 ## 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.
-• ./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.
-• ./icons/:     Icons for the sample script
+
+*  `./README`:     This file.
+* `./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.
+* `./icons/`:     Icons for the sample script

 
 
 ## Installation
 
 
 
 ## Installation
 

-First, edit ./config.mk to match your local setup.
+First, edit `./config.mk` to match your local setup.

 
 

-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,
+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
 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.
+creates the binary file `./xmenu`.

 
        make
 
 
        make
 

-By default, XMenu is installed into the /usr/local prefix.  Enter the
+By default, XMenu is installed into the `/usr/local` prefix.  Enter the

 following command to install XMenu (if necessary as root).  This command
 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.
+installs the binary file `./xmenu` into the `${PREFIX}/bin/` directory, and
+the manual file `./xmenu.1` into `${MANPREFIX}/man1/` directory.

 
        make install
 
 
        make install
 


@@ -66,11 +67,11 @@ 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 to use XMenu to draw a
-simple menu with submenus and separators.  The file ./demo.gif shows how
+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.
 
 the menu generated by that script looks like.
 

-Read the manual for more information on running XMenu.
+Read the [manual](https://github.com/phillbush/xmenu/wiki) for more information on running XMenu.

 
 
 ## License
 
 
 ## License