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-2015, 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](https://git-cola.github.io/screenshots.html).
  24
  25 ## DOWNLOAD
  26
  27     apt-get install git-cola python-pyinotify
  28
  29 New releases are available on the
  30 [git-cola download page](https://git-cola.github.io/downloads.html).
  31
  32 ## FORK
  33
  34     git clone git://github.com/git-cola/git-cola.git
  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, 2.7, and 3.2 or newer.
  49
  50 * [PyQt4](http://www.riverbankcomputing.co.uk/software/pyqt/download) 4.4 or newer
  51
  52 * [argparse](https://pypi.python.org/pypi/argparse) 1.1 or newer.
  53   argparse is part of the stdlib in Python 2.7; install argparse separately if
  54   you are running on Python 2.6.
  55
  56 * [Sphinx](http://sphinx-doc.org/) for building the documentation.
  57
  58 ## ADDITIVES
  59
  60 *git-cola* enables additional features when the following
  61 Python modules are installed.
  62
  63 [pyinotify](https://github.com/seb-m/pyinotify) 0.7.1 or newer
  64 enables inotify support on Linux.
  65
  66 [send2trash](https://github.com/hsoft/send2trash) enables cross-platform
  67 "Send to Trash" functionality.
  68
  69 # BREWING INSTRUCTIONS
  70
  71 ## RUN FROM SOURCE
  72
  73 You don't need to install *git-cola* to run it.
  74 Running *git-cola* from its source tree is the easiest
  75 way to try the latest version.
  76
  77     git clone git://github.com/git-cola/git-cola.git
  78     cd git-cola
  79     ./bin/git-cola
  80     ./bin/git-dag
  81
  82 Having *git-cola*'s *bin/* directory in your path allows you to run
  83 *git cola* like a regular built-in Git command:
  84
  85     # Replace "$PWD/bin" with the path to git-cola's bin/ directory
  86     PATH="$PWD/bin":"$PATH"
  87     export PATH
  88
  89     git cola
  90     git dag
  91
  92 The instructions below assume that you have *git-cola* present in your
  93 `$PATH`.  Replace "git cola" with "./bin/git-cola" as needed if you'd like to
  94 just run it in-place.
  95
  96 # INSTALLATION
  97
  98 Normally you can just do "make install" to install *git-cola*
  99 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
 100 If you want to do a global install you can do
 101
 102     make prefix=/usr install
 103
 104 There are also platform-specific installation methods.
 105 You'll probably want to use one of these anyways since they
 106 have a nice side-effect of installing *git-cola*'s PyQt4
 107 and argparse dependencies.
 108
 109 ## LINUX
 110
 111 Linux is it! Your distro has probably already packaged git-cola.
 112 If not, please file a bug against your distribution ;-)
 113
 114 ### arch
 115
 116     yaourt -S git-cola
 117
 118 ### debian, ubuntu
 119
 120     apt-get install git-cola
 121
 122 ### fedora
 123
 124     yum install git-cola
 125
 126 ### gentoo
 127
 128     emerge git-cola
 129
 130 ### opensuse
 131
 132 Use the [one-click install link](http://software.opensuse.org/package/git-cola).
 133
 134 ## MAC OS X
 135
 136 Before setting up homebrew, use
 137 [pip](https://pip.readthedocs.org/en/latest/installing.html) to install
 138 [sphinx](http://sphinx-doc.org/latest/install.html).
 139
 140 Sphinx is used to build the documentation.
 141
 142     sudo pip install sphinx
 143
 144 [Homebrew](http://mxcl.github.com/homebrew/) is the easiest way to install
 145 git-cola's *Qt4* and *PyQt4* dependencies.  We will use homebrew to install
 146 the git-cola recipe, but build our own .app bundle from source.
 147
 148     brew install git-cola
 149
 150 Once brew has installed git-cola you can:
 151
 152 1. Clone git-cola
 153
 154     `git clone git://github.com/git-cola/git-cola.git && cd git-cola`
 155
 156 2. Build the git-cola.app application bundle
 157
 158     `make git-cola.app`
 159
 160 3. Copy it to _/Applications_
 161
 162     `rm -fr /Applications/git-cola.app && cp -r git-cola.app /Applications`
 163
 164 ## WINDOWS INSTALLATION
 165
 166 Download the latest stable Git, Python 2.x, and Py2x-PyQt4 installers
 167
 168 * [msysGit](http://msysgit.github.com/)
 169
 170 * [Python](http://python.org/download/)
 171
 172 * [PyQt](http://www.riverbankcomputing.co.uk/software/pyqt/download/)
 173
 174 * [git-cola Installer](https://github.com/git-cola/git-cola/downloads)
 175
 176 Once these are installed you can run *git-cola* from the Start menu or
 177 by double-clicking on the `git-cola.pyw` script.
 178
 179 If you are developing *git-cola* on Windows you can use `python.exe` to run
 180 *git-cola* directly from source.
 181
 182     python.exe ./bin/git-cola
 183
 184 See "WINDOWS (continued)" below for more details.
 185
 186 # DOCUMENTATION
 187
 188 * [HTML documentation](https://git-cola.readthedocs.org/en/latest/)
 189
 190 * [git-cola manual](share/doc/git-cola/git-cola.rst)
 191
 192 * [git-dag manual](share/doc/git-cola/git-dag.rst)
 193
 194 * [Keyboard shortcuts](https://git-cola.github.io/share/doc/git-cola/hotkeys.html)
 195
 196 * [Contributing guidelines](CONTRIBUTING.md)
 197
 198 # GOODIES
 199
 200 *git-cola* ships with an interactive rebase editor called *git-xbase*.
 201 *git-xbase* can be used to reorder and choose commits and is typically
 202 launched through the *git-cola*'s "Rebase" menu.
 203
 204 *git-xbase* can also be launched independently of the main *git-cola* interface
 205 by telling `git rebase` to use it as its editor:
 206
 207     env GIT_SEQUENCE_EDITOR="$PWD/share/git-cola/bin/git-xbase" \
 208     git rebase -i origin/master
 209
 210 The quickest way to launch *git-xbase* is via the *git cola rebase*
 211 sub-command (as well as various other sub-commands):
 212
 213     git cola rebase origin/master
 214
 215 # COMMAND-LINE TOOLS
 216
 217 The *git-cola* command exposes various sub-commands that allow you to quickly
 218 launch tools that are available from within the *git-cola* interface.
 219 For example, `./bin/git-cola find` launches the file finder,
 220 and `./bin/git-cola grep` launches the grep tool.
 221
 222 See `git cola --help-commands` for the full list of commands.
 223
 224     $ git cola --help-commands
 225     usage: git-cola [-h]
 226
 227                     {cola,am,archive,branch,browse,classic,config,
 228                      dag,diff,fetch,find,grep,merge,pull,push,
 229                      rebase,remote,search,stash,tag,version}
 230                     ...
 231
 232     valid commands:
 233       {cola,am,archive,branch,browse,classic,config,
 234        dag,diff,fetch,find,grep,merge,pull,push,
 235        rebase,remote,search,stash,tag,version}
 236
 237         cola                start git-cola
 238         am                  apply patches using "git am"
 239         archive             save an archive
 240         branch              create a branch
 241         browse              browse repository
 242         classic             browse repository
 243         config              edit configuration
 244         dag                 start git-dag
 245         diff                view diffs
 246         fetch               fetch remotes
 247         find                find files
 248         grep                grep source
 249         merge               merge branches
 250         pull                pull remote branches
 251         push                push remote branches
 252         rebase              interactive rebase
 253         remote              edit remotes
 254         search              search commits
 255         stash               stash and unstash changes
 256         tag                 create tags
 257         version             print the version
 258
 259
 260 ## WINDOWS (continued)
 261
 262 # WINDOWS-ONLY HISTORY BROWSER CONFIGURATION UPGRADE
 263
 264 You may need to configure your history browser if you are upgrading from an
 265 older version of *git-cola*.
 266
 267 `gitk` was originally the default history browser, but `gitk` cannot be
 268 launched as-is on Windows because `gitk` is a shell script.
 269
 270 If you are configured to use `gitk`, then change your configuration to
 271 go through Git's `sh.exe` on Windows.  Similarly,we must go through
 272 `python.exe` if we want to use `git-dag`.
 273
 274 If you want to use *gitk* as your history browser open the
 275 *Preferences* screen and change the history browser command to:
 276
 277     C:/Git/bin/sh.exe --login -i C:/Git/bin/gitk
 278
 279 Alternatively, if you'd like to use *git-dag* as your history browser, use:
 280
 281     C:/Python27/python.exe C:/git-cola/bin/git-dag
 282
 283 *git-dag* became the default history browser on Windows in `v2.3`, so new
 284 users should not need to configure anything.
 285
 286 # BUILDING WINDOWS INSTALLERS
 287
 288 Windows installers are built using
 289 [Pynsist](http://pynsist.readthedocs.org/en/latest/).
 290 [NSIS](http://nsis.sourceforge.net/Main_Page) is also needed.
 291
 292 To build the installer using *Pynsist*:
 293
 294 1. (If building from a non-Windows platform), run
 295    `./contrib/win32/fetch_pyqt_windows.sh`.
 296    This will download a PyQt binary installer for Windows and unpack its files
 297    into `pynsist_pkgs/`.
 298 2. Run `pynsist pynsist.cfg`.
 299    The installer will be built in `build/nsis/`.
 300
 301
 302 Before *Pynsist*, installers were built using *InnoSetup*.
 303 The *InnoSetup* scripts are still available:
 304
 305     ./contrib/win32/create-installer.sh
 306
 307 You have to make sure that the file */share/InnoSetup/ISCC.exe* exists.
 308 That is normally the case when you run the *msysGit bash* and not the
 309 *Git for Windows bash* (look [here](http://msysgit.github.com/)
 310 for the differences).