INSTALLATION: mpy3-0.3.0

---------------------------------------------------------

I. Requirements:

There are a whole host of requirements for mpycurse. Here they are:

1. Linux/*BSD/MacOS X
Other unices might work but are untested. BSD has not been tested in awhile.
MacOS X does work, but the pymad and pyvorbis libraries which are dependencies
don't work out of the box. They can be patched or configured to work.

Unless new decoding and playback modules are made available, it's unlikely
that mpycurse will run on Windows.

2. Python >= 2.3
Mpycurse is a python program. While it might be possible to refactor it to
run on 2.2, it is unlikely to happen.

3. Programs:
  a. metakit (optional): this is used by the python module 'metakit'.

3. Libraries
  a. ncurses: This needs to exist so that the python 'curses' modules work.
              In many cases your OS will already have this.
  b. libao2: This is used by pyao for audio output.
  c. libmad (optional): This is used for mp3 playback by pymad.
  d. libogg/libvorbis (optional): This is used for vorbis playback by pyvorbis.

4. Python modules:
  a. curses: This should be part of the base python install.
  b. pyao: This module allows audio playback on ALSA/OSS/ESD and OS X.
  c. metakit (optional): this is used for metalibrary (saved-state, etc.)
  d. pymad (optional): Used to play mp3s
  e. pyogg, pyvorbis (optional): Used to play ogg vorbis files

You can test your system to see if all the feature's are working by running
(in the unpacked mpy3 directory) './check_dep.py'. This will print out a list
of possible dependencies, whether you meet each one, and whether or not the
program will function with the dependencies you have.

---------------------------------------------------------

II. Installation Procedure:

Mpycurse will install a 'mpy3' folder inside of the 'site-packages' directory
in your python installation. Likely locations of this directory are:

/usr/lib/python2.3/site-packages (Gentoo, Debian)
/usr/local/lib/python2.3/site-packages (RedHat, FreeBSD(?))

Less likely are:

/sw/lib/python2.3/site-packages (MacOS X)
/usr/pkg/lib/python2.3/site-packages (NetBSD)
/home/${USER}/lib/python2.3/site-packages (user installation of python)

Everything before the 'lib' heading is the install PREFIX. This PREFIX is
important, since it is also used to install documentation and other programs.
Here is where mpycurse will install into:

${PREFIX}/bin: mpycurse application and other utilities
${PREFIX}/share/mpy3: documentation and examples
${PREFIX}/lib/python2.3/site-packages/mpy3: python modules used by mpycurse

All you should need to do is run the following commands:

1. python setup.py build
2. (as root) python setup.py install

Python is usually very good at determining the ${PREFIX} it is being run from.
However, if you want to determine manually where ${PREFIX} is (and override
python's ability to auto-detect this) then instead of doing (2) you can do (2b):

2b. python setup.py install --prefix=${PREFIX}

That should prety much over it.

---------------------------------------------------------

III. Links:

Python:
http://www.python.org

Installing python modules:
http://docs.python.org/inst/inst.html