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 Lesser 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 Lesser 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         http://python.org/
  23
  24 GitPython
  25         http://gitorious.org/projects/git-python/
  26
  27 PyQt 4.3 or newer
  28         http://www.riverbankcomputing.co.uk/software/pyqt/intro
  29
  30
  31 INSTALLATION
  32
  33 Debian and RPM users can download freshly built binaries here:
  34
  35         http://ugit.sf.net/
  36
  37         sudo dpkg -i ugit_*.deb
  38         sudo rpm -ivh ugit-*.rpm
  39
  40
  41 If you downloaded a tarball, make sure /path/to/ugit/bin is in your $PATH.
  42
  43
  44 HOW TO RUN
  45
  46 Take your pick--any of the following incantations work from the command line:
  47
  48         git ugit
  49         git-ugit
  50         ugit
  51
  52 Launching ugit on repositories outside your $CWD:
  53
  54         git ugit /repo/path-1 /repo/path-2 .. /repo/path-N
  55
  56
  57 BUILDING FROM SOURCE
  58
  59 You will need the PyQt development tools (v4.3 or greater):
  60
  61 Synopsis:
  62         sudo apt-get install pyqt4-dev-tools
  63
  64         git clone git://repo.or.cz/ugit.git
  65         cd ugit
  66                 ./configure --prefix=/usr
  67                 make
  68                 sudo make install
  69
  70
  71 WINDOWS SUPPORT
  72
  73 Windows support once was quite experimental with git.
  74 These days it's actually quite good and only getting better
  75 everyday.  As git's windows support improves, so does ugit's.
  76
  77 The following is the combination that "works for me" (TM)
  78 as of late 2007:
  79
  80 1) Install the native Python2.5 and PyQt4 installers (in that order):
  81
  82         http://python.org/download/
  83         http://www.riverbankcomputing.co.uk/pyqt/download.php
  84
  85 3) Install git (the author had the best luck with msysgit):
  86
  87         http://git.or.cz/gitwiki/WindowsInstall
  88
  89 4) Download and unpack ugit:
  90
  91         http://ugit.sf.net/releases/
  92
  93 Grab the latest win32 tarball and run ugit-win32.sh from
  94 within an msysgit or cygwin shell.
  95
  96 The script assumes the you have Python/PyQt4 installed in C:/Python25.
  97 If this is not the case simply edit the script accordingly.
  98
  99 voila, ugit on Windows.
 100
 101
 102 NOTE: Windows is not the developer's primary platform.
 103 Patches are always greatly appreciated.