git cola: a highly caffeinated git gui

Cola is a sweet, carbonated git gui known for its
sugary flavour and caffeine-inspired features.


Copyright (C) 2008 David Aguilar and contributors

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 2 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/>.

REQUIREMENTS

Python 2.4 or newer
    http://python.org/
    apt-get install python

PyQt 4.3 or newer
    http://www.riverbankcomputing.co.uk/software/pyqt/intro
    apt-get install pyqt4-dev-tools


ADDITIONAL REQUIREMENTS (optional)

pyinotify (enables inotify support on Linux)
    http://pyinotify.sourceforge.net/
    apt-get install python-pyinotify

simplejson (enables bookmarks)
    http://pypi.python.org/pypi/simplejson
    apt-get install python-simplejson


ACKNOWLEDGEMENTS

git cola includes a copy of the GitPython module:
    http://gitorious.org/projects/git-python/


BUILDING FROM SOURCE

    git clone git://gitorious.org/git-cola/mainline.git cola

    make && bin/git-cola --style=dark # devcut test drive
    make prefix=/usr install          # global installation
    git cola                          # daily usage


INSTALLATION

Debian and RPM users can download freshly built binaries here:

    http://cola.tuxfamily.org/releases/


If you downloaded a tarball, make sure /path/to/cola/bin is in your $PATH.


HOW TO RUN

Take your pick--any of the following incantations work from the command line:

    git cola
    git-cola
    cola

Launching cola on repositories outside your $CWD:

    git cola /repo/path-1 /repo/path-2 .. /repo/path-N


STYLESHEETS

    git cola ships with an alternative stylesheet called "dark".
    You can use this stylesheet by running:

        git cola --style=dark


    You can also skin git cola by providing your own Qt stylesheet:

        git cola --style=/path/to/my/style.qss


    An example stylesheet is provided in:

        $PREFIX/share/cola/styles/dark.qss


WINDOWS INSTALLATION

1) Install the native Python2.5 and PyQt4 installers (in that order):

    http://python.org/download/
    http://www.riverbankcomputing.co.uk/pyqt/download.php

3) Install msysgit:

    http://git.or.cz/gitwiki/WindowsInstall

4) Install the GnuWin32 'file' command:

    http://gnuwin32.sourceforge.net/packages/file.htm

    Add the installed directory (default: c:\GnuWin32\bin) to your path.

5) Install simplejson

    http://pypi.python.org/pypi/simplejson

6) Download cola:

    http://cola.tuxfamily.org/releases/

7) Install cola (from a Git Bash):

    cd /c/Python25/Lib/site-packages
    tar xvfz /path/to/cola-win32-*.tar.gz
    mv cola-win32-* cola

8) Create an executable in your path for bash, cmd.exe, or both:

    echo '/c/Python25/python.exe /c/Python25/Lib/site-packages/cola/bin/git-cola' >> /usr/bin/cola
    echo 'c:\\Python25\\python.exe c:\\Python25\\Lib\\site-packages\\bin\\git-cola' > /c/Windows/System32/cola.bat

This assumes the you have Python/PyQt4 installed in C:/Python25.
If this is not the case simply edit the commands accordingly.

voila, cola on Windows.


NOTE: Windows is not the developer's primary platform.
Patches are greatly appreciated.