Browse Source

Convert README to markdown

Use markdown formatting for README file.
pull/4/head
George Vlahavas 10 years ago
parent
commit
51c2df2f65
  1. 26
      README

26
README

@ -1,23 +1,21 @@
=====
ABOUT ABOUT
===== =====
xdgmenumaker is a command line tool, written in python, that generates **xdgmenumaker** is a command line tool, written in python, that generates
application menus using xdg information, by scanning *.desktop files application menus using xdg information, by scanning `*.desktop` files
in all $XDG_DATA_DIRS/applications directories. All applications are in all `$XDG_DATA_DIRS/applications` directories. All applications are
sorted according to the main categories as specified by freedesktop.org sorted according to the main categories as specified by
at: [freedesktop.org](http://standards.freedesktop.org/menu-spec/latest/apa.html).
http://standards.freedesktop.org/menu-spec/latest/apa.html
The menu entries that are generated by xdgmenumaker are localised The menu entries that are generated by xdgmenumaker are localised
according to the running user locale settings. according to the running user locale settings.
xdgmenumaker currently supports generating menus for fluxbox, icewm, xdgmenumaker currently supports generating menus for **fluxbox**,
jwm, pekwm and windowmaker. **icewm**, **jwm**, **pekwm** and **windowmaker**.
pyxdg and pygtk are required by xdgmenumaker, in addition to python 2. pyxdg and pygtk are required by xdgmenumaker, in addition to python 2.
=======
Fluxbox Fluxbox
======= =======
@ -35,7 +33,7 @@ you want to update it, without having to run the command manually again:
[exec] (Update Fluxbox Menu) (xdgmenumaker -f fluxbox > ~/.fluxbox/xdg_menu) [exec] (Update Fluxbox Menu) (xdgmenumaker -f fluxbox > ~/.fluxbox/xdg_menu)
=====
IceWM IceWM
===== =====
@ -65,7 +63,7 @@ non existing icon, you essentially set it to use no icon. If you
actually have an icewm icon named "_none_", that one will be used actually have an icewm icon named "_none_", that one will be used
instead. instead.
===
JWM JWM
=== ===
@ -89,7 +87,6 @@ refresh the menu, like this:
<Program label="Refresh Menu">jwm -reload</Program> <Program label="Refresh Menu">jwm -reload</Program>
=====
pekwm pekwm
===== =====
@ -131,7 +128,6 @@ xdgmenumaker command and restart pekwm all over again to update it. The
advantage is that there will be no delay in displaying the menu. advantage is that there will be no delay in displaying the menu.
============
Window Maker Window Maker
============ ============
@ -164,7 +160,7 @@ probably not anything considerable.
Method 2 Method 2
-------- --------
Run Run:
$ xdgmenumaker -f windowmaker > ~/GNUstep/Defaults/xdg_menu $ xdgmenumaker -f windowmaker > ~/GNUstep/Defaults/xdg_menu

Loading…
Cancel
Save