===========================================================================

FtpCube is a graphical ftp client written in Python using the wxPython
graphical toolkit, and is based on LeechFTP by Jan Debis. FtpCube aims
to provide a high quality GUI, as well as a rich feature set, and
surpasses LeecFTP in terms of functionality.

===========================================================================

  FtpCube now relies on the wxPython toolkit for its graphical output.
A version of wxPython 2.3.3.1 is required and wxPython 2.4.0.2 is
suggested. wxPython is a fully cross-platform toolkit, which means
that FtpCube now runs on Unix, Windows, and MacOS. To obtain the
wxPython toolkit, please visit: http://www.wxpython.org. The wxPython
homepage can provide more information on what is necessary to get
wxPython up and running on your system, although binaries are
provided.

  If you have any comments, suggestions, please send them my way.

          -- Mike  <mgilfix@eecs.tufts.edu>

General notes:
==========================================================================

  The configuration format may change during versioning. If you are
experiencing any problems running a new version, please try removing your
~/.ftpcube directory and re-running the new version.

Installation:
==========================================================================

Note to CVS users:
--------------------------------------------------------------------------

  Unless you're using wxPython v2.4.0.2 or greater, you'll need to
obtain the wxPyColourChooser module.  This module is available at:
http://www.sourceforge.net/projects/wxcolourchooser.  Just move the
wxPyColourChooser directory inside the libftpcube directory.

Otherwise:
--------------------------------------------------------------------------

  The installation procedure makes use of python's distutils
module. If for some reason, the install fails or you don't have
the distutil module, please visit http://www.python.org to obtain
the module.

  To install python in your system, do the following:

    python setup.py build
    python setup.py install

  Then just run 'ftpcube' normally. Enjoy :) To get rid of the debugging
output, either set your PYTHONOPTIMIZE variable or run python with the -O
argument.

  If you'd like to change ftpcube's default installation locations, just
edit the 'setup.cfg' file before running a 'python setup.py install'.
The install_data field indicates where program shared data is stored on
your system. Normally, this is in /usr/share or /usr/local/share. Ftpcube
will put it's icons and translation files within this directory. The
install_script field indicates where the ftpcube executable is placed.

A Window Note:
==========================================================================

  To run Ftpcube on windows, simply click on the ftpcube.pyw file. That
will perform the correct launch for windows (meaning the separate
python window will not appear).
