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
  21 ## DOWNLOAD
  22
  23     apt-get install git-cola python-inotify
  24
  25 New releases are available on the
  26 [git-cola download page](http://git-cola.github.com/downloads.html).
  27
  28
  29 ## FORK
  30
  31     git clone git://github.com/git-cola/git-cola.git cola
  32
  33 [git-cola on github](https://github.com/git-cola/git-cola)
  34
  35 [git-cola google group](http://groups.google.com/group/git-cola/)
  36
  37
  38 # NUTRITIONAL FACTS
  39
  40
  41 ## ACTIVE INGREDIENTS
  42
  43 * [git](http://git-scm.com/) 1.6.3 or newer
  44
  45 * [Python](http://python.org/) 2.6 or newer
  46
  47 * [PyQt4](http://www.riverbankcomputing.co.uk/software/pyqt/download) 4.4 or newer
  48
  49 ## INOTIFY
  50
  51 [pyinotify](https://github.com/seb-m/pyinotify) >= 0.7.1
  52 enables inotify support on Linux.
  53
  54 # BREWING INSTRUCTIONS
  55
  56 Normally you can just do "make install" to install *git-cola*
  57 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
  58 If you want to do a global install you can do
  59
  60     make prefix=/usr install
  61
  62 You don't need to `make` to run it, though.
  63 *git-cola* is designed to run directly out of its source tree.
  64
  65     git clone git://github.com/git-cola/git-cola.git cola
  66     cola/bin/git-cola
  67     cola/bin/git-dag
  68
  69 ## MAC OS X
  70
  71 Whether you install cola yourself with `make install` or
  72 use the `git-cola.app` bundle, you will need to install
  73 *Qt4* and *PyQt4*.
  74
  75 The easiest way to do this is to [install homebrew](http://mxcl.github.com/homebrew/)
  76 and use it to install git-cola.
  77
  78     brew install git-cola
  79
  80 Once brew has installed git-cola (and its dependencies) you use
  81 `git-cola.app` or install from source using `make install`.
  82
  83 Installing these packages also gives you a PyQt development
  84 environment which can be used for building your own applications
  85 or hacking on cola itself.
  86
  87
  88 ## WINDOWS INSTALLATION
  89
  90 Download the latest stable Git, Python 2.6, and Py26-PyQt4 installers
  91
  92 * [msysGit](http://code.google.com/p/msysgit/)
  93
  94 * [Python](http://python.org/download/)
  95
  96 * [PyQt](http://www.riverbankcomputing.co.uk/software/pyqt/download/)
  97
  98 * [git-cola Installer](https://github.com/git-cola/git-cola/downloads)
  99
 100 Once these are installed you can run *git-cola* from the Start menu or
 101 from a Git Bash by typing `cola`.
 102
 103 If you are developing *git-cola* on Windows you can run the code by
 104 using the `win32/cola` shell script.
 105
 106     /c/Python26/python setup.py build
 107     win32/cola
 108
 109 The `win32/cola` script assumes that you have `python` installed in
 110 either `/c/Python26` or `/c/Python25`.  Adjust accordingly.