dag: Add documentation
[git-cola.git] / INSTALL
blob090efed65bcae467ad0a2119f98d953e0af18c90
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
42     $ bin/git-dag
45 MAC OS X INSTALLTION INSTRUCTIONS
47 Whether you install cola yourself with "make install" or
48 use the "git-cola.app" bundle, you will need to install
49 Qt and PyQt separately.
51 The easiest way to do this is to use brew.
53     ~ http://mxcl.github.com/homebrew/
54     $ brew install git-cola
56 Once brew has installed git-cola (and its dependencies) you use
57 git-cola.app or install from source using "make install".
58 Installing these packages also gives you a PyQt development
59 environment which can be used for building your own applications
60 or hacking on cola itself.
63 WINDOWS INSTALLATION
65 Download the latest stable Git, Python 2.6, and Py26-PyQt4 installers
66     http://code.google.com/p/msysgit/
67     http://python.org/download/
68     http://www.riverbankcomputing.co.uk/software/pyqt/download
70 Download the latest git-cola-[version].exe Windows installer
71     https://github.com/git-cola/git-cola/downloads
73 Once it's installed you can run it from the Start menu or
74 from a Git Bash by typing 'cola'.
76 If you're developing cola on Windows you can run cola out of its source
77 tree by using the 'win32/cola' shell script.
79     $ /c/Python26/python setup.py build
80     $ win32/cola
82 Note: win32/cola assumes you've installed Python in /c/Python26 or /c/Python25.
83 Adjust accordingly.
85 You can also add python to your path and run bin/git-cola directly.