tests: add a run_tests convenience script
[ugit.git] / README
blob682f3583f48ddd4b28e9092eb02f19ea82ccf16f
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 You will need the PyQt development tools (v4.3 or greater):
42         sudo apt-get install pyqt4-dev-tools
44         git clone git://repo.or.cz/ugit.git
45         cd ugit
46         ./configure --prefix=/usr && make && sudo make install
47         ugit
49 WINDOWS SUPPORT
51 Windows support once was quite experimental with git.
52 These days it's actually quite good and only getting better
53 everyday.  As git's windows support improves, so does ugit's.
55 The following is the combination that "works for me" (TM)
56 as of late 2007:
58 1) Install the native Python2.5 and PyQt4 installers (in that order):
60         http://python.org/download/
61         http://www.riverbankcomputing.co.uk/pyqt/download.php
63 3) Install git (the author had the best luck with msysgit):
65         http://git.or.cz/gitwiki/WindowsInstall
67 4) Download and unpack ugit:
68         http://ugit.sf.net/releases/
70 Grab the latest -win32 tarball and run ugit-win32.sh from
71 within an msysgit or cygwin shell.
73 The script assumes the you have Python/PyQt4 installed in C:/Python25.
74 If this is not the case, edit the script accordingly.
76 voila, ugit on Windows.