1This file is to help you configure, build and install Gource for your system.
2
3Contents
4========
5
61. Dependencies
72. Building
83. Configure Options
9
101. Dependencies
11===============
12
13Gource requires the following libraries to compile (package names may vary):
14
15    SDL 2.0 (libsdl2-dev)
16    SDL Image 2.0 (libsdl2-image-dev)
17    PCRE (libpcre3-dev)
18    Freetype 2 (libfreetype6-dev)
19    GLEW (libglew-dev)
20    GLM >= 0.9.3 (libglm-dev)
21    Boost Filesystem >= 1.46 (libboost-filesystem-dev)
22    PNG >= 1.2 (libpng-dev)
23
24Optional:
25
26   TinyXML (libtinyxml-dev)
27
28SDL Image 2.0 needs to have been built with support PNG and JPEG images.
29
302. Building
31===========
32
33Gource requires a GNU compatible C++ compiler that supports c++0x features such as 'auto' and the new 'for' loop syntax.
34
35GCC 4.6+ or Clang recommended.
36
37If you got the source directly from the Gource.git repository, you will first
38need to run autogen.sh which will generate the configure script and
39initialize and update the submodules.
40
41    ./autogen.sh
42
43Generic build instructions for Linux/Mac OS:
44
45    ./configure
46    make
47    make install
48
49Building on Windows:
50
51On Windows compile gource.pro with Qt Creator.
52
53A pre-built version for Windows is normally available from the homepage.
54
55Gource expects SDL to have been built with the NO_STDIO_REDIRECT flag.
56
573. Configure Options
58====================
59
60By default Gource will install some GNU FreeFont TTF Fonts on your system.
61
62If you already have these fonts, you can configure Gource to use them with:
63
64    ./configure --enable-ttf-font-dir=/path/to/freefont/
65
66You can also build Gource with a different font:
67
68    ./configure --enable-font-file=/path/to/alternate/font.ttf
69
70The font file format must be supported by Free Type 2.
71
72Gource includes a copy of TinyXML. To build against the system version of the
73library use:
74
75    ./configure --with-tinyxml
76
77