Makefile: Change "make dist" tarball to git-cola-$version.tar.gz
[git-cola.git] / INSTALL
blobf09a58b388d3d163ad71798485c82ea2740d6a3b
1 NUTRITIONAL FACTS
2 -----------------
4 ACTIVE INGREDIENTS
5     # apt-get install git-core python python-qt4
7 Python 2.6 or newer
8     ~ http://python.org/
10 PyQt 4.4 or newer
11     ~ http://www.riverbankcomputing.co.uk/software/pyqt/download
14 ADDITIVES
15     # apt-get install python-pyinotify
17 pyinotify >= 0.7.1 enables inotify support on Linux
18     ~ http://pyinotify.sourceforge.net/
21 BREWING INSTRUCTIONS
22     # apt-get install pyqt4-dev-tools
24 Normally you can just do "make install" to install git-cola
25 in your $HOME directory ($HOME/bin, $HOME/lib, etc).
26 If you want to do a global install you can do
28     # make prefix=/usr install
30 You don't need to install cola to run it.
31 git-cola is designed to run directly out of its source tree.
33     $ make
34     $ bin/git-cola
35     $ bin/git-dag
38 MAC OS X INSTALLTION INSTRUCTIONS
40 Whether you install cola yourself with "make install" or
41 use the "git-cola.app" bundle, you will need to install
42 Qt and PyQt separately.
44 The easiest way to do this is to use brew.
46     ~ http://mxcl.github.com/homebrew/
47     $ brew install git-cola
49 Once brew has installed git-cola (and its dependencies) you use
50 git-cola.app or install from source using "make install".
51 Installing these packages also gives you a PyQt development
52 environment which can be used for building your own applications
53 or hacking on cola itself.
56 WINDOWS INSTALLATION
58 Download the latest stable Git, Python 2.6, and Py26-PyQt4 installers
59     http://code.google.com/p/msysgit/
60     http://python.org/download/
61     http://www.riverbankcomputing.co.uk/software/pyqt/download
63 Download the latest git-cola-[version].exe Windows installer
64     https://github.com/git-cola/git-cola/downloads
66 Once it's installed you can run it from the Start menu or
67 from a Git Bash by typing 'cola'.
69 If you're developing cola on Windows you can run cola out of its source
70 tree by using the 'win32/cola' shell script.
72     $ /c/Python26/python setup.py build
73     $ win32/cola
75 Note: win32/cola assumes you've installed Python in /c/Python26 or /c/Python25.
76 Adjust accordingly.
78 You can also add python to your path and run bin/git-cola directly.