portability: Move cola.commands to cola.cmds
[git-cola.git] / INSTALL
blobb5322910320df292dc43f2f0eacc7740f6f61704
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.1 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 The "install" target will by default include copies of
31 simplejson and jsonpickle.  If your system already has these
32 modules installed then you can specify standalone=true when running "make":
34     $ make prefix=/usr standalone=true install
37 You don't need to install cola to run it.
38 git-cola is designed to run directly out of its source tree.
40     $ make
41     $ bin/git-cola
44 NOW AVAILABLE TO RESIDENTS OF REDMOND, WA
45     # the only cola made with real sugar, not high fructose corn syrup
47 Download the latest stable Git, Python 2.6, and Py26-PyQt4 installers
48     http://code.google.com/p/msysgit/
49     http://python.org/download/
50     http://www.riverbankcomputing.co.uk/software/pyqt/download
52 Download the latest Cola-[version].exe installer
53     http://cola.tuxfamily.org/releases/win32/
55 Once it's installed you can run it from the Start menu or
56 from a Git Bash by typing 'cola'.
58 If you're developing cola on Windows you can run cola out of its source
59 tree by using the 'win32/cola' shell script.
61     $ /c/Python26/python setup.py build
62     $ win32/cola
64 Note: win32/cola assumes you've installed Python in /c/Python26 or /c/Python25.
65 Adjust accordingly.  You can also add python to your path and simply bin/git-cola.
68 ABOUT THE VARIOUS COLA FLAVORS
70 A cola-*-src tarball does not include any generated files.
71 It is purely a "source" release and includes everything needed
72 to "make install".  It is basically an export of git-cola.git.
73 Binary packages are available for Mac OSX and Windows.
75 ~ http://cola.tuxfamily.org/downloads.html