compare: add a BranchCompareController for use by Branch->Compare
[git-cola.git] / INSTALL
blob31ad8a2aaedd13902f9fa9aa8db0f07ca81c1fcd
1 INSTALLATION
2 ------------
4 Debian and RPM users can download freshly built binaries here:
6     http://cola.tuxfamily.org/releases/
8 If you downloaded a tarball add /path/to/cola/bin to your $PATH.
11 REQUIREMENTS
13 Python 2.4 or newer
14     http://python.org/
15     apt-get install python
17 PyQt 4.3 or newer
18     http://www.riverbankcomputing.co.uk/software/pyqt/intro
19     apt-get install pyqt4-dev-tools
22 ADDITIONAL REQUIREMENTS (optional)
24 pyinotify (enables inotify support on Linux -- highly recommended)
25     http://pyinotify.sourceforge.net/
26     apt-get install python-pyinotify
28 simplejson (enables bookmarks)
29     http://pypi.python.org/pypi/simplejson
30     apt-get install python-simplejson
33 BUILDING FROM SOURCE
35 Normally you can just do "make install" to install git-cola
36 in your $HOME directory ($HOME/bin, $HOME/lib, etc).
37 If you want to do a global install you can do
39     # make prefix=/usr install
42 WINDOWS INSTALLATION
44 1) Install the native Python2.5 and PyQt4 installers (in that order):
46     http://python.org/download/
47     http://www.riverbankcomputing.co.uk/pyqt/download.php
49 3) Install msysgit:
51     http://git.or.cz/gitwiki/WindowsInstall
53 4) Install the GnuWin32 'file' command:
55     http://gnuwin32.sourceforge.net/packages/file.htm
57     Add the installed directory (default: c:\GnuWin32\bin) to your path.
59 5) Install simplejson
61     http://pypi.python.org/pypi/simplejson
63 6) Download cola:
65     http://cola.tuxfamily.org/releases/
67 7) Install cola (from a Git Bash):
69     cd /c/Python25/Lib/site-packages
70     tar xvfz /path/to/cola-*-win32.tar.gz
71     mv cola-*-win32 cola
73 8) Create an executable in your path for bash, cmd.exe, or both:
75     echo '/c/Python25/python.exe /c/Python25/Lib/site-packages/cola/bin/git-cola' >> /usr/bin/cola
76     echo 'c:\\Python25\\python.exe c:\\Python25\\Lib\\site-packages\\cola\\bin\\git-cola' > /c/Windows/System32/cola.bat
78 This assumes the you have Python/PyQt4 installed in C:/Python25.
79 If this is not the case simply edit the commands accordingly.
81 voila, cola on Windows.
84 NOTE: Windows is not the developer's primary platform.
85 Patches are greatly appreciated.