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, 2008, 2009, 2010, 2011, 2012, 2013
   6     David Aguilar and contributors
   7
   8     This program is free software: you can redistribute it and/or modify
   9     it under the terms of the GNU 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 General Public License
  19     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 ## SCREENSHOTS
  22
  23 Screenshots are available on the
  24 [git-cola screenshots page](http://git-cola.github.io/screenshots.html).
  25
  26 ## DOWNLOAD
  27
  28     apt-get install git-cola python-pyinotify
  29
  30 New releases are available on the
  31 [git-cola download page](http://git-cola.github.io/downloads.html).
  32
  33 ## FORK
  34
  35     git clone git://github.com/git-cola/git-cola.git cola
  36
  37 [git-cola on github](https://github.com/git-cola/git-cola)
  38
  39 [git-cola google group](http://groups.google.com/group/git-cola/)
  40
  41
  42 # NUTRITIONAL FACTS
  43
  44
  45 ## ACTIVE INGREDIENTS
  46
  47 * [git](http://git-scm.com/) 1.6.3 or newer
  48
  49 * [Python](http://python.org/) 2.5 through 2.7
  50
  51 * [PyQt4](http://www.riverbankcomputing.co.uk/software/pyqt/download) 4.4 or newer
  52
  53 ## INOTIFY
  54
  55 [pyinotify](https://github.com/seb-m/pyinotify) >= 0.7.1
  56 enables inotify support on Linux.
  57
  58 # BREWING INSTRUCTIONS
  59
  60 Normally you can just do "make install" to install *git-cola*
  61 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
  62 If you want to do a global install you can do
  63
  64     make prefix=/usr install
  65
  66 You don't need to `make` to run it, though.
  67 *git-cola* is designed to run directly out of its source tree.
  68
  69     git clone git://github.com/git-cola/git-cola.git cola
  70     cola/bin/git-cola
  71     cola/bin/git-dag
  72
  73 ## MAC OS X
  74
  75 Whether you install cola yourself with `make install` or
  76 use the `git-cola.app` bundle, you will need to install
  77 *Qt4* and *PyQt4*.
  78
  79 The easiest way to do this is to [install homebrew](http://mxcl.github.com/homebrew/)
  80 and use it to install git-cola.
  81
  82     brew install git-cola
  83
  84 Once brew has installed git-cola (and its dependencies) you use
  85 `git-cola.app` or install from source using `make install`.
  86
  87 Installing these packages also gives you a PyQt development
  88 environment which can be used for building your own applications
  89 or hacking on cola itself.
  90
  91
  92 ## WINDOWS INSTALLATION
  93
  94 Download the latest stable Git, Python 2.x, and Py2x-PyQt4 installers
  95
  96 * [msysGit](http://msysgit.github.com/)
  97
  98 * [Python](http://python.org/download/)
  99
 100 * [PyQt](http://www.riverbankcomputing.co.uk/software/pyqt/download/)
 101
 102 * [git-cola Installer](https://github.com/git-cola/git-cola/downloads)
 103
 104 Once these are installed you can run *git-cola* from the Start menu or
 105 by double-clicking on the `git-cola.pyw` script.
 106
 107 You can also use `pythonw.exe` to invoke the `git-cola.pyw` script
 108 directly from the command-line.
 109
 110 If you are developing *git-cola* on Windows you can run it from its
 111 source tree by using `pythonw.exe`.
 112
 113     pythonw.exe bin/git-cola
 114
 115 If you want to build the `git-cola Installer` yourself run the provided script
 116
 117     win32/create-installer.sh
 118
 119 You have to make sure that the file
 120
 121     /share/InnoSetup/ISCC.exe
 122
 123 exists. That is normally the case when you run the *msysGit bash* and
 124 not the *Git for Windows bash* (look [here](http://msysgit.github.com/)
 125 for the differences).