INSTALL

   1                 TopGit installation
   2
   3 Direct from source
   4 ------------------
   5
   6 Although TopGit is essentially a bunch of shell scripts (and their
   7 accompanying documentation), it does require some preprocessing.
   8
   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
  12
  13    # make prefix=/usr install ;# as root
  14
  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; make prefix=/usr install" would not work.
  18
  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.
  22
  23 To install the html version of the help you need rst2html.py and then use
  24 "make html" followed by "make install-html".  The same use of prefix=
  25 applies here as well.
  26
  27 The TopGit git repository can be found at: http://repo.or.cz/topgit/pro
  28
  29
  30 Other
  31 -----
  32
  33 Alternatively, you can install using OS/distro-specific packages or similar
  34 - which should also pull in git as a dependency if you are installing on
  35 a machine which does not already have git installed.
  36
  37 Note that most such packages have not yet been updated to point to the new
  38 TopGit repo on GitHub. Ones that have are listed below:
  39
  40 Linux
  41 ~~~~~
  42
  43 * Fedora/EPEL/QubesOS: yum install topgit
  44 * Exherbo: cave resolve dev-scm/topgit -x
  45 * Nix: nix-env -f nixpkgs-version -i topgit
  46 * OpenSuSE: http://software.opensuse.org/download.html?project=home:arvidjaar:TopGIT&package=topgit [unofficial]
  47
  48 Mac OS X
  49 ~~~~~~~~
  50
  51 * Nix: nix-env -f nixpkgs-version -i topgit
  52
  53 FreeBSD
  54 ~~~~~~~
  55
  56 none as yet