INSTALL

FTGL Version 2.0.5

This project will build a static library (archive) in the src directory.

The Makefiles need GNU Make in order to work properly.

The easiest way to start is to try autogen.

    $ ./autogen.sh

If this completes successfully, it means that the system was able to
deduce the location of all prerequisites. Next, configure the makefiles

    $ ./configure

This will configure the default build configuration with a target install
directory of /usr/local. This is adequate for most users.

FTGL requires the Freetype2 library (version 2.0.9 or later) and OpenGL
(glu version 1.2 or later). If these libraries cannot be found by autogen,
you can pass flags to the configure script to point it to the place where
these libraries are installed, like this:

    $ ./configure --with-gl-inc=/usr/local/include \
                  --with-gl-lib=/usr/local/lib

Should you need anything more complicated that that, try with:

    $ ./configure --with-gl-inc=/usr/local/include \
                  --with-gl-lib="-L/weird/location -lGL -lX11 -lXi -lXm"

The same thing goes for the GLUT library.  This is optional and is only
needed to build the demo program.  Should any of this fail, please send
an email to mmagallo@debian.org (please include FTGL somewhere in the
subject line) and include a copy of the config.log file that was left
behind.

Once the build is configured, simple run make

    $ make

To install the library, you will probably require superuser permission:

    $ sudo make install

If doxygen is installed, documentation in HTML format will be generated
in the docs subdirectory.

To use FTGL in your own projects you will need to link against this lib
and include the FTGL headers located in the src directory. Your project
will also need Freetype and OpenGL.  For your convinience a pkg-config
metadata file has been included (ftgl.pc) and gets installed in
<libdir>/pkgconfig, where pkg-config should be able to find it.  In
order to take advantage of this, just include something like this in
your makefiles:

    FTGL_CPPFLAGS := $(shell pkg-config --cflags ftgl)
    FTGL_LDFLAGS  := $(shell pkg-config --libs-only-L ftgl)
    FTGL_LIBS     := $(shell pkg-config --libs-only-l ftgl)

The names of these variables should be self-explanatory.  Note that
FTGL_LIBS will include -lGL, you shouldn't specify that flag separately.

For instructions on using Freetype go to http://www.freetype.org/
For instructions on using OpenGL go to http://www.opengl.org/

Please contact me if you have any suggestions, feature requests, or
problems.

Henry Maddocks
henryj@paradise.net.nz
http://homepages.paradise.net.nz/henryj/