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