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 and then use
  24 "make html" followed by "make install-html".  The same use of prefix=
  25 applies here as well.  Set RST2HTML to the location of the rst2html
  26 executabile if it's not named "rst2html" or not located in $PATH.  Also
  27 note that "make doc" and "make install-doc" will accomplish the same thing.
  28
  29 The standard DESTDIR variable is supported to install to an intermediate
  30 location before moving to the final intended destination via some other means.
  31
  32 The TopGit git repository can be found at: http://repo.or.cz/topgit/pro
  33
  34
  35 Other
  36 -----
  37
  38 Alternatively, you can install using OS/distro-specific packages or similar
  39 - which should also pull in git as a dependency if you are installing on
  40 a machine which does not already have git installed.
  41
  42 Note that most such packages have not yet been updated to point to the new
  43 TopGit repo on GitHub. Ones that have are listed below:
  44
  45 Linux
  46 ~~~~~
  47
  48 * Fedora/EPEL/QubesOS: yum install topgit
  49 * Exherbo: cave resolve dev-scm/topgit -x
  50 * Nix: nix-env -f nixpkgs-version -i topgit
  51 * openSUSE: https://software.opensuse.org/download.html?project=devel:tools:scm&package=topgit
  52
  53 Mac OS X
  54 ~~~~~~~~
  55
  56 * Nix: nix-env -f nixpkgs-version -i topgit
  57
  58 FreeBSD
  59 ~~~~~~~
  60
  61 none as yet