Remove some unused data and small fixups
[ugit.git] / README
blobd619da6e773a650c9094e407b075614d9dcba61d
1 ugit: A PyQt-based git gui
3 Copyright (C) 2007 David Aguilar
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.
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.
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/>.
19 REQUIREMENTS
21 Python 2.4 or newer
22 PyQt 4.3 or newer
25 INSTALLATION
27 If you downloaded a tarball, run:
28 /path/to/ugit-x.y.z/bin/ugit.py
30 If for some reason ugit.py is unable to locate its
31 libraries, add its site-packages directory to your $PYTHONPATH:
33 PYTHONPATH=/path/to/ugit-x.y.z/lib/python2.4/site-packages
34 export PYTHON
35 /path/to/ugit-x.y.z/bin/ugit.py
38 BUILDING FROM SOURCE
40 ./configure --prefix=/usr
41 make && sudo make install
44 WINDOWS SUPPORT
46 Windows supported is experimental at its the worst, and
47 o.k. at its best.  This is purely because Linux is the
48 author's primary platform.  Any help is greatly appreciated,
49 especially with bugs/troubleshooting.
51 The following is the combination that "works for me"(TM)
52 as of late 2007:
54 1) Install the native Python2.5 and PyQt4 installers (in that order):
56         http://python.org/download/
57         http://www.riverbankcomputing.co.uk/pyqt/download.php
59 3) Install git (the author had the best luck with msysgit):
61         http://git.or.cz/gitwiki/WindowsInstall
63 4) Download and unpack ugit:
64         http://ugit.justroots.com/
66 Grab the latest -win32 tarball and run either ugit-msysgit.sh or ugit-cygwin.sh
67 from within an msysgit (or cygwin) shell.
69 The script assumes the you have Python/PyQt4 installed in C:\Python25.
70 If this is not the case, edit the script accordingly.
72 voila, ugit on Windows.