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