README

   1 ugit: A PyQt-based git gui
   2
   3 Copyright (C) 2008 David Aguilar
   4
   5 This program is free software: you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation, either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18
  19 REQUIREMENTS
  20
  21 Python 2.4 or newer
  22 PyQt 4.3 or newer
  23
  24
  25 INSTALLATION
  26
  27 Debian and RPM users can download freshly built binaries here:
  28
  29         http://ugit.sf.net/
  30
  31         sudo dpkg -i ugit_*.deb
  32         sudo rpm -ivh ugit-*.rpm
  33
  34
  35 If you downloaded a tarball, make sure /path/to/ugit/bin is in your $PATH.
  36
  37
  38 HOW TO RUN
  39
  40 Take your pick--any of the following incantations work from the command line:
  41
  42         git ugit
  43         git-ugit
  44         ugit
  45
  46 Launching ugit on repositories outside your $CWD:
  47
  48         git ugit /repo/path-1 /repo/path-2 .. /repo/path-N
  49
  50
  51 BUILDING FROM SOURCE
  52
  53 You will need the PyQt development tools (v4.3 or greater):
  54
  55 Synopsis:
  56         sudo apt-get install pyqt4-dev-tools
  57
  58         git clone git://repo.or.cz/ugit.git
  59         cd ugit
  60                 ./configure --prefix=/usr
  61                 make
  62                 sudo make install
  63
  64
  65 WINDOWS SUPPORT
  66
  67 Windows support once was quite experimental with git.
  68 These days it's actually quite good and only getting better
  69 everyday.  As git's windows support improves, so does ugit's.
  70
  71 The following is the combination that "works for me" (TM)
  72 as of late 2007:
  73
  74 1) Install the native Python2.5 and PyQt4 installers (in that order):
  75
  76         http://python.org/download/
  77         http://www.riverbankcomputing.co.uk/pyqt/download.php
  78
  79 3) Install git (the author had the best luck with msysgit):
  80
  81         http://git.or.cz/gitwiki/WindowsInstall
  82
  83 4) Download and unpack ugit:
  84
  85         http://ugit.sf.net/releases/
  86
  87 Grab the latest win32 tarball and run ugit-win32.sh from
  88 within an msysgit or cygwin shell.
  89
  90 The script assumes the you have Python/PyQt4 installed in C:/Python25.
  91 If this is not the case simply edit the script accordingly.
  92
  93 voila, ugit on Windows.
  94
  95
  96 NOTE: Windows is not the developer's primary platform.
  97 Patches are always greatly appreciated.