Update README.md
authorGideon Wolfe <wolfeg2@wwu.edu>
Wed, 29 Jul 2020 20:09:10 +0000 (13:09 -0700)
committerGitHub <noreply@github.com>
Wed, 29 Jul 2020 20:09:10 +0000 (13:09 -0700)
README.md

index 23c3569..8c48534 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,11 +10,9 @@ 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).
 
-[0]: https://github.com/phillbush/xclickroot
-
 
 ## Features
 
@@ -28,33 +26,34 @@ XMenu comes with the following features:
 ## 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
 
-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
-creates the binary file ./xmenu.
+creates the binary file `./xmenu`.
 
        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
-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
 
@@ -66,7 +65,7 @@ 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 to use XMenu to draw a
+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.