=====================
How To Install Mitter
=====================

Requirements
============

Mitter requires Python, at least version 2.5. Version 2.6 should be
fine. There is no guarantee that it will work with Python 3.0 at this
point.

For the GTK interface, you'll need PyGTK installed. The minimum
version is 2.10 and Mitter should work fine with any further version
in the 2.x series. Again, there is no guarantee that it will work with
GTK 3.0 when it's released. Also notice that PyGTK is optional and
Mitter will use its console interfaces in this case.

Installation
============

Installation follows the default way of installing Python apps:

Using easy_install
------------------

You can install Mitter using easy_install. To install, simply call
``easy_install mitter``.  It may require root access to install some
files.

easy_install will download the latest version registered on Cheese Shop
( http://pypi.python.org ), unpack and install it.

Using setup.py
--------------

After unpacking the Mitter package, you'll find a ``setup.py`` file.
To install, call ``python setup.py install`` and it will install
Mitter in ``/usr/local/bin``. To install in a different directory, use
the ``--prefix`` parameter. ``python setup.py help`` will show other
options you can use.