README

   1 git-cola: a highly caffeinated git gui
   2
   3 Cola is a sweet, carbonated git gui known for its
   4 sugary flavour and caffeine-inspired features.
   5
   6 Copyright (C) 2008 David Aguilar
   7
   8 This program is free software: you can redistribute it and/or modify
   9 it under the terms of the GNU Lesser General Public License as published by
  10 the Free Software Foundation, either version 2 of the License, or
  11 (at your option) any later version.
  12
  13 This program is distributed in the hope that it will be useful,
  14 but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU Lesser General Public License
  19 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21
  22 REQUIREMENTS
  23
  24 Python 2.4 or newer
  25     http://python.org/
  26
  27 GitPython
  28     http://gitorious.org/projects/git-python/
  29
  30 PyQt 4.3 or newer
  31     http://www.riverbankcomputing.co.uk/software/pyqt/intro
  32
  33 simplejson
  34     http://pypi.python.org/pypi/simplejson
  35
  36 INSTALLATION
  37
  38 Debian and RPM users can download freshly built binaries here:
  39
  40     http://cola.tuxfamily.org/
  41
  42     sudo dpkg -i cola_*.deb
  43     sudo rpm -ivh cola-*.rpm
  44
  45
  46 If you downloaded a tarball, make sure /path/to/cola/bin is in your $PATH.
  47
  48
  49 HOW TO RUN
  50
  51 Take your pick--any of the following incantations work from the command line:
  52
  53     git cola
  54     git-cola
  55     cola
  56
  57 Launching cola on repositories outside your $CWD:
  58
  59     git cola /repo/path-1 /repo/path-2 .. /repo/path-N
  60
  61
  62 BUILDING FROM SOURCE
  63
  64 You will need the PyQt development tools (v4.3 or greater):
  65
  66 Synopsis:
  67     sudo apt-get install pyqt4-dev-tools
  68     git clone git://gitorious.org/git-cola/mainline.git cola
  69     cd cola
  70     ./configure --prefix=/usr
  71     make
  72     sudo make install
  73
  74
  75 WINDOWS INSTALLATION
  76
  77 1) Install the native Python2.5 and PyQt4 installers (in that order):
  78
  79     http://python.org/download/
  80     http://www.riverbankcomputing.co.uk/pyqt/download.php
  81
  82 3) Install msysgit:
  83
  84     http://git.or.cz/gitwiki/WindowsInstall
  85
  86 4) Install GitPython
  87
  88     http://gitorious.org/projects/git-python/
  89
  90 5) Install the GnuWin32 'file' command:
  91
  92     http://gnuwin32.sourceforge.net/packages/file.htm
  93
  94     Add the installed directory (default: c:\GnuWin32\bin) to your path.
  95
  96 6) Install simplejson
  97
  98     http://pypi.python.org/pypi/simplejson
  99
 100 7) Download cola:
 101
 102     http://cola.tuxfamily.org/releases/
 103
 104 8) Install cola (from a Git Bash):
 105
 106     cd /c/Python25/Lib/site-packages
 107     tar xvfz /path/to/cola-win32-*.tar.gz
 108     mv cola-win32-* cola
 109
 110 9) Create an executable in your path for bash, cmd.exe, or both:
 111
 112     echo '/c/Python25/python.exe /c/Python25/Lib/site-packages/cola/bin/git-cola' >> /usr/bin/cola
 113     echo 'c:\\Python25\\python.exe c:\\Python25\\Lib\\site-packages\\bin\\git-cola' > /c/Windows/System32/cola.bat
 114
 115 This assumes the you have Python/PyQt4 installed in C:/Python25.
 116 If this is not the case simply edit the commands accordingly.
 117
 118 voila, cola on Windows.
 119
 120
 121 NOTE: Windows is not the developer's primary platform.
 122 Patches are greatly appreciated.