README

   1 Commit Tool - (H)GCT
   2 ====================
   3
   4
   5 Introduction
   6 ------------
   7
   8 Commit Tool or (h)gct is a GUI enabled commit tool for git and
   9 Mercurial (hg). It allows the user to view diffs, select which files
  10 to committed (or ignored / reverted) write commit messages and perform
  11 the commit itself.
  12
  13 The latest version of (h)gct can always be downloaded from the Git
  14 repository at git://repo.or.cz/hgct.git (use
  15 http://repo.or.cz/w/hgct.git for gitweb access)
  16
  17 Any comments, suggestions and/or bug reports regarding gct are greatly
  18 appreciated.
  19
  20     Fredrik Kuivinen, <frekui@gmail.com>
  21     Mark Williamson, <mark.williamson@cl.cam.ac.uk>
  22
  23
  24 Requirements
  25 ------------
  26
  27 * Python, http://www.python.org
  28 * Qt version 3.*, http://www.trolltech.com/products/qt/index.html
  29 * PyQt, http://www.riverbankcomputing.co.uk/pyqt/
  30 * Git a fairly recent snapshot,
  31   http://www.kernel.org/pub/software/scm/git/ and
  32   rsync://rsync.kernel.org/pub/scm/git/git.git
  33 * Mercurial support (if desired) requires hg version 0.6c or newer,
  34   http://www.selenic.com/mercurial/
  35
  36 (h)gct has been developed with Python 2.3, Qt 3.3.4 and PyQt
  37 2.13. Other fairly recent versions of those programs do probably also
  38 work.
  39
  40
  41 Installation
  42 ------------
  43
  44 The commands
  45
  46     make
  47     make install
  48
  49 should be enough to install the executable 'gct' (and the symlink
  50 'hgct') in ~/bin.  To install under another prefix, use
  51
  52     make PREFIX=/path/to/install install
  53
  54 For instance, set PREFIX=/usr/local/ for a system-wide install.
  55
  56 If (h)gct is started with 'gct' then Git will be used as the
  57 underlying SCM, if it is started with 'hgct' Hg will be used as the
  58 SCM.