$Id: INSTALL 3 2006-03-28 11:52:53Z sgrayban $

INSTALLATION
------------

PyBMP is packaged with Distutils (the current standard way to package Python
extensions), so its installation should be as simple as:
  - make this file's directory your shell's current directory
  - edit setup.cfg and make sure that it fits your needs (particularly the
    installation prefix)
  - a) 1) type:

            python ./setup.py build

          This step requires the development files for Python, glib and bmp
          (these include C header files). They are perhaps provided by
          packages named python-dev, libglib-dev, libbeep-media-player-devel
          or something similar with a version number... This depends on your
          OS or Linux distribution.

          Note: the glib library required is the one that BMP uses,
                which is currently 1.2 (BMP does not use the GNOME 2 API at
                all at the time of this writing).

       2) then, as root:

            python ./setup.py install --record /path/to/foo

          where foo is a file of your choice which will contain the list of
          all files installed on your system by the preceding command. This
          will make uninstallation easy (you could ommit the
          "--record/path/to/foo", but uninstallation could not be automated,
          then).

    OR

    b) type, as root:

            python ./setup.py install --record /path/to/foo

       This will automatically build the package before installing it. The
       observations made in a) also apply here.


If this default installation is not what you wish, please read the Distutils
documentation. It should be included in the base Python documentation and the
chapter you'll need is most probably "Installing Python Modules".


UNINSTALLATION
--------------

Provided you have followed the instructions given in the installation section,
you have a /path/to/foo file that contains all the files the installation
process put on your system. Great! All you have to do is:

   while read file; do rm -f "$file"; done < /path/to/foo

under a Bourne-compatible shell and with the appropriate privileges (maybe
root, depending on where you installed PyBMP).

Note: this will handle file names with spaces correctly, unlike the simpler
"rm -f $(cat /path/to/foo)".