version: use the current branch when determining the automatic version
[git-cola.git] / INSTALL
blob114840e4a275cd935ceaf49ddb7f1e2bde6096a9
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
41 To build cola on windows you'll need to add the following
42 shell script to a directory in your path and name it 'pyuic4':
44 #+-------------------------------------------------------------
46 #!/bin/sh
47 /c/Python25/python.exe \
48 /c/Python25/Lib/site-packages/PyQt4/uic/pyuic.py "$@"
50 #+-------------------------------------------------------------
53 WINDOWS INSTALLATION
55 1) Install the native Python2.5 and PyQt4 installers (in that order):
57     http://python.org/download/
58     http://www.riverbankcomputing.co.uk/pyqt/download.php
60 3) Install msysgit:
62     http://git.or.cz/gitwiki/WindowsInstall
64 4) Install the GnuWin32 'file' command:
66     http://gnuwin32.sourceforge.net/packages/file.htm
68     Add the installed directory (default: c:\GnuWin32\bin) to your path.
70 5) Install simplejson
72     http://pypi.python.org/pypi/simplejson
74 6) Download cola:
76     http://cola.tuxfamily.org/releases/
78 7) Install cola (from a Git Bash):
80     cd /c/Python25/Lib/site-packages
81     tar xvfz /path/to/cola-*-win32.tar.gz
82     mv cola-*-win32 cola
84 8) Create an executable in your path for bash, cmd.exe, or both:
86     echo '/c/Python25/python.exe /c/Python25/Lib/site-packages/cola/bin/git-cola' >> /usr/bin/cola
87     echo 'c:\\Python25\\python.exe c:\\Python25\\Lib\\site-packages\\cola\\bin\\git-cola' > /c/Windows/System32/cola.bat
89 This assumes the you have Python/PyQt4 installed in C:/Python25.
90 If this is not the case simply edit the commands accordingly.
92 voila, cola on Windows.
95 NOTE: Windows is not the developer's primary platform.
96 Patches are greatly appreciated.