Make tig handle GIT_DIR better
[tig] / INSTALL
CommitLineData
f4657f00
JF
1Installation instructions
2-------------------------
3
4Download a tarball from http://jonas.nitro.dk/tig/releases[] or clone the tig
5repository http://jonas.nitro.dk/tig/tig.git[]. Documentation files are
6available either in the tarballs or in the above repository in the branch named
7'release'.
8
9To install tig simply run:
10
11 $ make install
12
13To install documentation run:
14
15 $ make install-docs
16
42ea463a
JF
17Edit the Makefile if you need to configure specific compiler or linker flags.
18On FreeBSD for example the c library does not support the iconv interface and
19to compile tig you need to append `-L/usr/local/lib -liconv` to `LDLIBS` and
20`-I/usr/local/include` to the `CFLAGS` variable.
21
f4657f00
JF
22The following tools and packages are needed:
23
24`-------------------------------`----------------------------------------------
25Tool Description
26-------------------------------------------------------------------------------
27git-core Tig is just a frontend for git.
28ncurses Be sure to also have development files \
2bc4f7bd 29 installed. Usually they are available in a \
f4657f00 30 separate package ending with `-dev`.
42ea463a
JF
31iconv If iconv is not provided by the c library \
32 you need to change the Makefile to link it \
33 into the binary.
f4657f00
JF
34asciidoc (>= 7.0), xmlto For building documentation. (Optional)
35-------------------------------------------------------------------------------