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-2018, 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
  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 build status](https://api.travis-ci.org/git-cola/git-cola.svg?branch=master)](https://travis-ci.org/git-cola/git-cola)
  37
  38 [git-cola on github](https://github.com/git-cola/git-cola)
  39
  40 [git-cola google group](http://groups.google.com/group/git-cola/)
  41
  42
  43 # NUTRITIONAL FACTS
  44
  45 ## ACTIVE INGREDIENTS
  46
  47 * [git](http://git-scm.com/) 1.6.3 or newer.
  48
  49 * [Python](http://python.org/) 2.6 or newer (Python 2+3 compatible).
  50
  51 * [QtPy](https://github.com/spyder-ide/qtpy) 1.1.0 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.
  56
  57 * [Sphinx](http://sphinx-doc.org/) for building the documentation.
  58
  59 *git-cola* uses *QtPy*, so you can choose between *PyQt4*, *PyQt5*, and
  60 *PySide* by setting the `QT_API` environment variable to `pyqt4`, `pyqt5` or
  61 `pyside` as desired.  `qtpy` defaults to `pyqt5` and falls back to `pyqt4`
  62 if `pyqt5` is not installed.
  63
  64 Any of the following Python Qt libraries must be installed:
  65
  66 * [PyQt4](https://www.riverbankcomputing.com/software/pyqt/download)
  67   4.6 or newer
  68
  69 * [PyQt5](https://www.riverbankcomputing.com/software/pyqt/download5)
  70   5.2 or newer
  71
  72 * [PySide](https://github.com/PySide/PySide)
  73   1.1.0 or newer
  74
  75 Set `QT_API=pyqt4` in your environment if you have both
  76 versions of *PyQt* installed and want to ensure that PyQt4 is used.
  77
  78 *NOTE*: *git-cola* includes a vendored copy of its *QtPy* dependency.
  79
  80 We provide a copy of the `qtpy` module when installing *git-cola* so that you
  81 are not required to install *QtPy* separately.  If you'd like to provide your
  82 own `qtpy` module, for example from the `python-qtpy` Debian package, then use
  83 `make NO_VENDOR_LIBS=1 ...` when invoking `make`, or export
  84 `GIT_COLA_NO_VENDOR_LIBS=1` into the build environment.
  85
  86
  87 ## ADDITIVES
  88
  89 *git-cola* enables additional features when the following
  90 Python modules are installed.
  91
  92 [send2trash](https://github.com/hsoft/send2trash) enables cross-platform
  93 "Send to Trash" functionality.
  94
  95 # BREWING INSTRUCTIONS
  96
  97 ## RUN FROM SOURCE
  98
  99 You don't need to install *git-cola* to run it.
 100 Running *git-cola* from its source tree is the easiest
 101 way to try the latest version.
 102
 103     git clone git://github.com/git-cola/git-cola.git
 104     cd git-cola
 105     ./bin/git-cola
 106     ./bin/git-dag
 107
 108 Having *git-cola*'s *bin/* directory in your path allows you to run
 109 *git cola* like a regular built-in Git command:
 110
 111     # Replace "$PWD/bin" with the path to git-cola's bin/ directory
 112     PATH="$PWD/bin":"$PATH"
 113     export PATH
 114
 115     git cola
 116     git dag
 117
 118 The instructions below assume that you have *git-cola* present in your
 119 `$PATH`.  Replace "git cola" with "./bin/git-cola" as needed if you'd like to
 120 just run it in-place.
 121
 122 # DOCUMENTATION
 123
 124 * [HTML documentation](https://git-cola.readthedocs.io/en/latest/)
 125
 126 * [git-cola manual](share/doc/git-cola/git-cola.rst)
 127
 128 * [git-dag manual](share/doc/git-cola/git-dag.rst)
 129
 130 * [Keyboard shortcuts](https://git-cola.github.io/share/doc/git-cola/hotkeys.html)
 131
 132 * [Contributing guidelines](CONTRIBUTING.md)
 133
 134 # INSTALLATION
 135
 136 Normally you can just do "make install" to install *git-cola*
 137 in your `$HOME` directory (`$HOME/bin`, `$HOME/share`, etc).
 138 If you want to do a global install you can do
 139
 140     make prefix=/usr install
 141
 142 The platform-specific installation methods below use the native
 143 package manager.  You should use one of these so that all of *git-cola*'s
 144 dependencies are installed.
 145
 146 ## LINUX
 147
 148 Linux is it! Your distro has probably already packaged git-cola.
 149 If not, please file a bug against your distribution ;-)
 150
 151 ### arch
 152
 153     yaourt -S git-cola
 154
 155 ### debian, ubuntu
 156
 157     apt-get install git-cola
 158
 159 ### fedora
 160
 161     dnf install git-cola
 162
 163 ### gentoo
 164
 165     emerge git-cola
 166
 167 ### opensuse
 168
 169 Use the [one-click install link](http://software.opensuse.org/package/git-cola).
 170
 171
 172 ## MAC OS X
 173
 174 [Homebrew](http://brew.sh/) is the easiest way to install
 175 git-cola's *Qt4* and *PyQt4* dependencies.  We will use Homebrew to install
 176 the git-cola recipe, but build our own .app bundle from source.
 177
 178 [Sphinx](http://sphinx-doc.org/latest/install.html) is used to build the
 179 documentation.
 180
 181     brew install sphinx-doc
 182     brew install git-cola
 183
 184 Once brew has installed git-cola you can:
 185
 186 1. Clone git-cola
 187
 188     `git clone git://github.com/git-cola/git-cola.git && cd git-cola`
 189
 190 2. Build the git-cola.app application bundle
 191
 192     ```
 193     make \
 194         PYTHON=$(brew --prefix python3)/bin/python3 \
 195         PYTHON_CONFIG=$(brew --prefix python3)/bin/python3-config \
 196         SPHINXBUILD=$(brew --prefix sphinx-doc)/bin/sphinx-build \
 197         git-cola.app
 198    ```
 199
 200 3. Copy it to _/Applications_
 201
 202     `rm -fr /Applications/git-cola.app && cp -r git-cola.app /Applications`
 203
 204 Newer versions of Homebrew install their own `python3` installation and
 205 provide the `PyQt5` modules for `python3` only.  You have to use
 206 `python3 ./bin/git-cola` when running from the source tree.
 207
 208 ### UPGRADING USING HOMEBREW
 209
 210 If you upgrade using `brew` then it is recommended that you re-install
 211 *git-cola*'s dependencies when upgrading.  Re-installing ensures that the
 212 Python modules provided by Homebrew will be properly setup.
 213
 214 This is required when upgrading to a modern (post-10.11 El Capitan) Mac OS X.
 215 Homebrew now bundles its own Python3 installation instead of using the
 216 system-provided default Python.
 217
 218
 219     # update homebrew
 220     brew update
 221
 222     # uninstall git-cola and its dependencies
 223     brew uninstall git-cola
 224     brew uninstall pyqt5
 225     brew uninstall sip
 226
 227     # re-install git-cola and its dependencies
 228     brew install git-cola
 229
 230 ## WINDOWS INSTALLATION
 231
 232 **IMPORTANT** If you have a 64-bit machine, install the 64-bit versions only.
 233 Do not mix 32-bit and 64-bit versions.
 234
 235 Download and install the following:
 236
 237 * [Git for Windows](https://git-for-windows.github.io/)
 238
 239 * [Git Cola](https://github.com/git-cola/git-cola/releases)
 240
 241 Once these are installed you can run *git cola* from the Start menu.
 242
 243 See "WINDOWS (continued)" below for more details.
 244
 245 # GOODIES
 246
 247 *git-cola* ships with an interactive rebase editor called *git-xbase*.
 248 *git-xbase* can be used to reorder and choose commits and is typically
 249 launched through the *git-cola*'s "Rebase" menu.
 250
 251 *git-xbase* can also be launched independently of the main *git-cola* interface
 252 by telling `git rebase` to use it as its editor:
 253
 254     env GIT_SEQUENCE_EDITOR="$PWD/share/git-cola/bin/git-xbase" \
 255     git rebase -i origin/master
 256
 257 The quickest way to launch *git-xbase* is via the *git cola rebase*
 258 sub-command (as well as various other sub-commands):
 259
 260     git cola rebase origin/master
 261
 262 # COMMAND-LINE TOOLS
 263
 264 The *git-cola* command exposes various sub-commands that allow you to quickly
 265 launch tools that are available from within the *git-cola* interface.
 266 For example, `./bin/git-cola find` launches the file finder,
 267 and `./bin/git-cola grep` launches the grep tool.
 268
 269 See `git cola --help-commands` for the full list of commands.
 270
 271     $ git cola --help-commands
 272     usage: git-cola [-h]
 273
 274                     {cola,am,archive,branch,browse,config,
 275                      dag,diff,fetch,find,grep,merge,pull,push,
 276                      rebase,remote,search,stash,tag,version}
 277                     ...
 278
 279     valid commands:
 280       {cola,am,archive,branch,browse,config,
 281        dag,diff,fetch,find,grep,merge,pull,push,
 282        rebase,remote,search,stash,tag,version}
 283
 284         cola                start git-cola
 285         am                  apply patches using "git am"
 286         archive             save an archive
 287         branch              create a branch
 288         browse              browse repository
 289         config              edit configuration
 290         dag                 start git-dag
 291         diff                view diffs
 292         fetch               fetch remotes
 293         find                find files
 294         grep                grep source
 295         merge               merge branches
 296         pull                pull remote branches
 297         push                push remote branches
 298         rebase              interactive rebase
 299         remote              edit remotes
 300         search              search commits
 301         stash               stash and unstash changes
 302         tag                 create tags
 303         version             print the version
 304
 305 ## HACKING
 306
 307 The following commands should be run during development:
 308
 309     # Run the unit tests
 310     $ make test
 311
 312     # Check for pylint warnings.  All new code must pass 100%.
 313     $ make pylint3k
 314
 315 The test suite can be found in the [test](test) directory.
 316
 317 The tests are setup to run automatically when code is pushed using
 318 [Travis CI](https://travis-ci.org/git-cola/git-cola).
 319 Checkout the [Travis config file](.travis.yml) for more details.
 320
 321 When submitting patches, consult the [contributing guidelines](CONTRIBUTING.md).
 322
 323 # WINDOWS (continued)
 324
 325 ## Development
 326
 327 In order to develop *git cola* on Windows you will need to install
 328 Python3 and pip.  Install PyQt5 using `pip install PyQt5`
 329 to make the PyQt5 bindings available to Python.
 330
 331 Once these are installed you can use `python.exe` to run
 332 directly from the source tree.  For example, from a Git Bash terminal:
 333
 334     /c/Python36/python.exe ./bin/git-cola
 335
 336 ## Multiple Python versions
 337
 338 If you have multiple versions of Python installed, the `contrib/win32/cola`
 339 launcher script might choose the newer version instead of the python
 340 that has PyQt installed.  In order to resolve this, you can set the
 341 `cola.pythonlocation` git configuration variable to tell cola where to
 342 find python.  For example:
 343
 344     git config --global cola.pythonlocation /c/Python36
 345
 346 ## BUILDING WINDOWS INSTALLERS
 347
 348 Windows installers are built using
 349
 350 * [Pynsist](http://pynsist.readthedocs.io/en/latest/).
 351
 352 * [NSIS](http://nsis.sourceforge.net/Main_Page) is also needed.
 353
 354 To build the installer using *Pynsist* run:
 355
 356    ./contrib/win32/run-pynsist.sh
 357
 358 This will generate an installer in `build/nsis/`.
 359
 360 ## WINDOWS HISTORY BROWSER CONFIGURATION UPGRADE
 361
 362 You may need to configure your history browser if you are upgrading from an
 363 older version of *git-cola*.
 364
 365 `gitk` was originally the default history browser, but `gitk` cannot be
 366 launched as-is on Windows because `gitk` is a shell script.
 367
 368 If you are configured to use `gitk`, then change your configuration to
 369 go through Git's `sh.exe` on Windows.  Similarly,we must go through
 370 `python.exe` if we want to use `git-dag`.
 371
 372 If you want to use *gitk* as your history browser open the
 373 *Preferences* screen and change the history browser command to:
 374
 375     "C:/Program Files/Git/bin/sh.exe" --login -i C:/Git/bin/gitk
 376
 377 *git-dag* became the default history browser on Windows in `v2.3`, so new
 378 users should not need to configure anything.