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
  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 * [argparse](https://pypi.python.org/pypi/argparse) 1.1 or newer
  54   argparse is part of the stdlib in Python 2.7; install argparse separately if
  55   you are running on Python 2.6 or below.
  56
  57 ## ADDITIVES
  58
  59 [pyinotify](https://github.com/seb-m/pyinotify) 0.7.1 or newer
  60 enables inotify support on Linux.
  61
  62 # BREWING INSTRUCTIONS
  63
  64 Normally you can just do "make install" to install *git-cola*
  65 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
  66 If you want to do a global install you can do
  67
  68     make prefix=/usr install
  69
  70 You don't need to `make` to run it, though.
  71 *git-cola* is designed to run directly out of its source tree.
  72
  73     bin/git-cola
  74     bin/git-dag
  75
  76 ## MAC OS X
  77
  78 Whether you install cola yourself with `make install` or
  79 use the `git-cola.app` bundle, you will need to install
  80 *Qt4* and *PyQt4*.
  81
  82 The easiest way to do this is to [install homebrew](http://mxcl.github.com/homebrew/)
  83 and use it to install git-cola.
  84
  85     brew install git-cola
  86
  87 Once brew has installed git-cola (and its dependencies) you either use
  88 `git-cola.app`, run from source, or install from source via `make install`.
  89 You can build `git-cola.app` by running `make git-cola.app`.
  90
  91 Installing these packages also gives you a PyQt development
  92 environment which can be used for building your own applications
  93 or hacking on cola itself.
  94
  95 ## WINDOWS INSTALLATION
  96
  97 Download the latest stable Git, Python 2.x, and Py2x-PyQt4 installers
  98
  99 * [msysGit](http://msysgit.github.com/)
 100
 101 * [Python](http://python.org/download/)
 102
 103 * [PyQt](http://www.riverbankcomputing.co.uk/software/pyqt/download/)
 104
 105 * [git-cola Installer](https://github.com/git-cola/git-cola/downloads)
 106
 107 Once these are installed you can run *git-cola* from the Start menu or
 108 by double-clicking on the `git-cola.pyw` script.
 109
 110 If you are developing *git-cola* on Windows you can use `python.exe` to run
 111 *git-cola* directly from source.
 112
 113     python.exe bin/git-cola
 114
 115 If you want to build the `git-cola Installer` yourself run the provided script
 116
 117     contrib/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).
 126
 127 ## GOODIES
 128
 129 *git-cola* ships with an interactive rebase editor called *git-xbase*.
 130 *git-xbase* can be used to reorder and choose commits and can be launched
 131 independently of the main *git-cola* interface, e.g.:
 132
 133     GIT_SEQUENCE_EDITOR=$PWD/share/git-cola/bin/git-xbase git rebase -i master