Read Me

##
## xfce-menu-maker.py                    
## Copyright Berkeley Churchill 2011    
## berkeley@berkeleychurchill.com       
## www.berkeleychurchill.com/software
## https://sourceforge.net/projects/xfce-menu-maker/
## 
## This program is free software: you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
## 
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
## 
## You should have received a copy of the GNU General Public License
## along with this program.  If not, see <http://www.gnu.org/licenses/>.
## 

######### GETTING STARTED ##########

This program should be easy to use.  There are three steps to creating your menu.

1) Write a configuration file.  See the sample file included in this package.

2) Run xfce-menu-maker.py.  By default it will look for xfce4-menu-maker.conf, but you can specify any configuration file as an argument.


3) You will need to modify an xfce configuration file once per new menu you create.  Instructions to do this are outputted by the program.  If you miss them, have no fear -- just run xfce-menu-maker again.  You only need to do this once each time you want to add a menu to a panel.  For example, if you delete an executable, you only need to run xfce-menu-maker again and won't need to edit the configuration file.

######### EXAMPLE ##########

Running

./xfce-menu-maker.py sample-configuration.conf

and then following the provided instructions displayed should work properly.  It will make a menu of all the executables in /usr/games and allow you to place them on an xfce toolbar.

######### USAGE ##########

Usage:
./xfce-menu-maker.py [-v] [-q] [-h|--help] [config-file]

If config-file is ommitted, it defaults to xfce-menu-maker.conf, ~/.xfce-menu-maker.conf or /etc/xfce-menu-maker.conf. More details about configuration can be found at https://sourceforge.net/projects/xfce-menu-maker/.  

-v increases verbosity
-q suppresses all output


######### CONFIGURATION FILE #########

See the sample configuration file for the syntax of the file.  The sample file creates a menu with all the applications in /usr/games.  

######### INSTALL #########

To install this program permanently, simply place it somewhere in your path.  Copying it to /usr/local/bin usually suffices for this purpose.  Renaming it without the .py instructions is optional.