Bumped version to 0.9; last minute doc changes
[topgit.git] / INSTALL
blob17c5ad2f8988b86467378f9b8fed423d604d6073
1                 TopGit installation
3 Direct from source
4 ------------------
6 Although TopGit is essentially a bunch of shell scripts (and their
7 accompanying documentation), it does require some preprocessing.
9 Normally you can just do "make" followed by "make install", and that will
10 install the tg program in your own ~/bin/ directory.  If you want to do a
11 global install, you can do
13    # make prefix=/usr install ;# as root
15 (or prefix=/usr/local, of course).  Just like any program suite that uses
16 $prefix, the built results have some paths encoded, which are derived from
17 $prefix, so "make all; make prefix=/usr install" would not work.
19 The Makefile does not currently install the bash completion support in
20 contrib/tg-completion.bash. Instructions for installing that file are at the
21 top of that file.
24 Other
25 -----
27 Alternatively, you can install using OS/distro-specific packages or similar
28 - which should also pull in git as a dependency if you are installing on
29 a machine which does not already have git installed.
31 Note that most such packages have not yet been updated to point to the new
32 TopGit repo on GitHub. Ones that have are listed below:
34 Linux
35 ~~~~~
37 * OpenSuSE: http://software.opensuse.org/download.html?project=home:arvidjaar:TopGIT&package=topgit [unofficial]
39 Mac OS X
40 ~~~~~~~~
42 none as yet
44 FreeBSD
45 ~~~~~~~
47 none as yet