README.md

   1 # git-cola: The highly caffeinated git GUI
   2
   3     git-cola is a powerful git GUI with a slick and intuitive user interface.
   4
   5     Copyright (C) 2007-2012, David Aguilar and contributors
   6
   7     This program is free software: you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation, either version 2 of the License, or
  10     (at your option) any later version.
  11
  12     This program is distributed in the hope that it will be useful,
  13     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15     GNU General Public License for more details.
  16
  17     You should have received a copy of the GNU General Public License
  18     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 ## SCREENSHOTS
  21
  22 Screenshots are available on the
  23 [git-cola screenshots page](http://git-cola.github.com/screenshots.html).
  24
  25 ## DOWNLOAD
  26
  27     apt-get install git-cola python-inotify
  28
  29 New releases are available on the
  30 [git-cola download page](http://git-cola.github.com/downloads.html).
  31
  32 ## FORK
  33
  34     git clone git://github.com/git-cola/git-cola.git cola
  35
  36 [git-cola on github](https://github.com/git-cola/git-cola)
  37
  38 [git-cola google group](http://groups.google.com/group/git-cola/)
  39
  40
  41 # NUTRITIONAL FACTS
  42
  43
  44 ## ACTIVE INGREDIENTS
  45
  46 * [git](http://git-scm.com/) 1.6.3 or newer
  47
  48 * [Python](http://python.org/) 2.6 or newer
  49
  50 * [PyQt4](http://www.riverbankcomputing.co.uk/software/pyqt/download) 4.4 or newer
  51
  52 ## INOTIFY
  53
  54 [pyinotify](https://github.com/seb-m/pyinotify) >= 0.7.1
  55 enables inotify support on Linux.
  56
  57 # BREWING INSTRUCTIONS
  58
  59 Normally you can just do "make install" to install *git-cola*
  60 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
  61 If you want to do a global install you can do
  62
  63     make prefix=/usr install
  64
  65 You don't need to `make` to run it, though.
  66 *git-cola* is designed to run directly out of its source tree.
  67
  68     git clone git://github.com/git-cola/git-cola.git cola
  69     cola/bin/git-cola
  70     cola/bin/git-dag
  71
  72 ## MAC OS X
  73
  74 Whether you install cola yourself with `make install` or
  75 use the `git-cola.app` bundle, you will need to install
  76 *Qt4* and *PyQt4*.
  77
  78 The easiest way to do this is to [install homebrew](http://mxcl.github.com/homebrew/)
  79 and use it to install git-cola.
  80
  81     brew install git-cola
  82
  83 Once brew has installed git-cola (and its dependencies) you use
  84 `git-cola.app` or install from source using `make install`.
  85
  86 Installing these packages also gives you a PyQt development
  87 environment which can be used for building your own applications
  88 or hacking on cola itself.
  89
  90
  91 ## WINDOWS INSTALLATION
  92
  93 Download the latest stable Git, Python 2.6, and Py26-PyQt4 installers
  94
  95 * [msysGit](http://code.google.com/p/msysgit/)
  96
  97 * [Python](http://python.org/download/)
  98
  99 * [PyQt](http://www.riverbankcomputing.co.uk/software/pyqt/download/)
 100
 101 * [git-cola Installer](https://github.com/git-cola/git-cola/downloads)
 102
 103 Once these are installed you can run *git-cola* from the Start menu or
 104 from a Git Bash by typing `cola`.
 105
 106 If you are developing *git-cola* on Windows you can run the code by
 107 using the `win32/cola` shell script.
 108
 109     /c/Python26/python setup.py build
 110     win32/cola
 111
 112 The `win32/cola` script assumes that you have `python` installed in
 113 either `/c/Python26` or `/c/Python25`.  Adjust accordingly.