contrib/README.md

   1 # Git Cola Accessories
   2
   3 ## Bash shell completion
   4
   5 The [git-cola-completion.bash](git-cola-complation.bash) script can be sourced
   6 by `.bashrc` or `/etc/bash_completion.d` to provide completion for `git cola`
   7 on the command-line.
   8
   9 Git Cola's bash completion script requires that you have Git's
  10 [git-completion.bash](https://github.com/git/git/blob/master/contrib/completion/git-completion.bash)
  11 setup via your `.bashrc`. Git Cola's completion script is a plugin / extension
  12 to Git's `git-completion.bash`.
  13
  14
  15 ## Zsh shell completion
  16
  17 * The [_git-cola zsh completion script](_git-cola) is a completion script for `zsh`.
  18 This script is only able to offer completions for the dashed `git-cola` command.
  19 Completions for `git cola` are not currently available.
  20
  21 To use it, copy `_git-cola` to the location where you keep your zsh completion scripts
  22 (ie. `mkdir  -p ~/.config/zsh/completion && cp _git-cola ~/.config/zsh/completion`)
  23 and then add the directory to zsh's `$fpath` in your `~/.zshrc` before initializing
  24 the completion system using `compinit`:
  25
  26     # ~/.zshrc shell completion setup
  27     fpath=(~/.config/zsh/completion $fpath)
  28     autoload -U +X compinit
  29     compinit
  30
  31
  32 ## macOS-related files
  33
  34 The [darwin](darwin) directory contains resources for creating Mac OS X
  35 git-cola.app application bundles.
  36
  37
  38 ## Windows-related files
  39
  40 The [win32](win32) directory contains packaging-related utilities and
  41 resources for the Windows installer.  If you're developing git-cola on
  42 Windows then you can use the `cola` and `dag` helper scripts to launch
  43 git-cola from your source tree without needing to have python.exe in your path.