commands: Add an AddSignoff command
[git-cola.git] / INSTALL
blob630aa14589d3630dfc404a11c1f1fff82a380513
1 NUTRITIONAL FACTS
2 -----------------
4 ACTIVE INGREDIENTS
5     # apt-get install git-core python python-qt4
7 Python 2.4 or newer
8     ~ http://python.org/
10 PyQt 4.3 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
37 NOW AVAILABLE TO RESIDENTS OF REDMOND, WA
38     # the only cola made with real sugar, not high fructose corn syrup
40 Download the latest stable Git, Python 2.6, and Py26-PyQt4 installers
41     http://code.google.com/p/msysgit/
42     http://python.org/download/
43     http://www.riverbankcomputing.co.uk/software/pyqt/download
45 Download the latest Cola-[version].exe installer
46     http://cola.tuxfamily.org/releases/win32/
48 Once it's installed you can run it from the Start menu or
49 from a Git Bash by typing 'cola'.
51 If you're developing cola on Windows you can run cola out of its source
52 tree by using the 'win32/cola' shell script.
54     $ /c/Python26/python setup.py build
55     $ win32/cola
57 Note: win32/cola assumes you've installed Python in /c/Python26 or /c/Python25.
58 Adjust accordingly.  You can also add python to your path and simply bin/git-cola.
61 ABOUT THE VARIOUS COLA FLAVORS
63 A cola-*-src tarball does not include any generated files --
64 it is purely a "source" release and includes everything needed
65 to generate a cola release.  It is basically an export of git-cola.git.
66     ~ http://cola.tuxfamily.org/releases/.
68 A cola-*-release tarball contains all of the generated gui files and is
69 designed to be run as-is.  These are provided for convenience so that
70 users are not required to have the PyQt4 development tools installed in
71 order to use cola.
72     ~ http://cola.tuxfamily.org/releases/release/.
74 A cola-*-win32 tarball contains extra scripts for use on Windows.
75 It's easier to just use the .exe installer these days, but if you're
76 paranoid and would rather just download a tarball then that's cool too.
77     ~ http://cola.tuxfamily.org/releases/win32/.