setup.py: Try git when printing the release version
[git-cola.git] / INSTALL
blob1bfee5735f106b383dafb50fddc51a805b5dd94c
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 MAC OS X INSTALLTION INSTRUCTIONS
46 Whether you install cola yourself with "make install" or
47 use the "git-cola.app" bundle, you will need to install
48 Qt and PyQt separately.
50 The easiest way to do this is to download the appropriate
51 installers for your platform.  If you have a platform
52 not listed here then we can use your help so that an
53 appropriate PyQt download can be made available.
55 For Intel Leopard machines that means installing:
57     "Cocoa: Mac binary package for Mac OS X 10.5 - 10.6 (32-bit and 64-bit)"
58     ~ http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x/
59     ~ http://get.qt.nokia.com/qt/source/qt-mac-opensource-4.7.1.dmg
61 and PyQt from the git-cola google code download page:
63    "PyQt 4.8.2 for Intel Leopard"
64     ~ http://code.google.com/p/git-cola/downloads/list
67 For Intel Snow Leopard machines download both the Qt and PyQt
68 snow leopard packages and install them:
70     "Qt x.x.x for Intel Snow Leopard"
71     ~ http://code.google.com/p/git-cola/downloads/list
73     "PyQt x.x.x for Intel Snow Leopard"
74     ~ http://code.google.com/p/git-cola/downloads/list
76 Once these have been installed then you can download either
77 git-cola.app or install from source using "make install".
78 Installing these packages also gives you a PyQt development
79 environment which can be used for building your own applications
80 or hacking on cola itself.
83 NOW AVAILABLE TO RESIDENTS OF REDMOND, WA
84     # the only cola made with real sugar, not high fructose corn syrup
86 Download the latest stable Git, Python 2.6, and Py26-PyQt4 installers
87     http://code.google.com/p/msysgit/
88     http://python.org/download/
89     http://www.riverbankcomputing.co.uk/software/pyqt/download
91 Download the latest git-cola-[version].exe installer
92     http://cola.tuxfamily.org/releases/win32/
94 Once it's installed you can run it from the Start menu or
95 from a Git Bash by typing 'cola'.
97 If you're developing cola on Windows you can run cola out of its source
98 tree by using the 'win32/cola' shell script.
100     $ /c/Python26/python setup.py build
101     $ win32/cola
103 Note: win32/cola assumes you've installed Python in /c/Python26 or /c/Python25.
104 Adjust accordingly.
106 You can also add python to your path and run bin/git-cola directly.