contrib/README.md

   1 Miscellaneous git-cola utilities
   2 ================================
   3
   4 The [git-cola bash completion script](git-cola-complation.bash) can be sourced
   5 by `.bashrc` or `/etc/bash_completion.d` to provide completion for `git cola`
   6 on the command-line.
   7
   8 The [travis-build script](travis-build) lets you execute git-cola's
   9 [travis build script](../.travis.yml) locally.  This makes it possible
  10 to debug the travis build on your local machine.  e.g. you can execute
  11 the python2.7 integration tests in .travis.yaml using your system-default
  12 python2.7 inside a virtualenv:
  13
  14     $ virtualenv --python /usr/bin/python2.7 env27
  15     $ source env27/bin/activate
  16     $ pip install pyyaml
  17     $ ./contrib/travis-build -V 2.7 .travis.yaml
  18
  19 This script can run any travis-like build.yaml file, so we use it to provide a
  20 [python2.6 build script](build-python2.6.sh) and accompanying
  21 [yaml build config](build-python2.6.yaml) that bootstraps a python2.6
  22 virtualenv in the `env26` directory for running the .travis.yaml unit tests.
  23
  24 `build-python2.6.sh` was developed on Debian/sid, where python2.6 is not
  25 available and SSLv3 has been removed.  This allows us to run the unittests
  26 for compatibility testing.  This script uses your existing Qt library,
  27 and rebuilds Python, sip, and PyQt4.
  28
  29 [build-git-cola.sh](build-git-cola.sh) shows how to build git-cola on an older
  30 Unix/Linux OS, such as RHEL5, where Python 2.6 or newer is not available, and
  31 we want to use a newer version of Qt4 than what is provided on the system.
  32 This script rebuilds all of Qt4, Python, and PyQt4.
  33
  34 The [darwin](darwin) directory contains resources for creating Mac OS X
  35 git-cola.app application bundles.
  36
  37 The [win32](win32) directory contains packaging-related utilities and
  38 resources for the Windows installer.  If you're developing git-cola on
  39 Windows then you can use the `cola` and `dag` helper scripts to launch
  40 git-cola from your source tree without needing to have python.exe in your path.