blob: 13cb896ba23b920687286605bacbce2bb7d03891 [file] [log] [blame]
Werner Lemberg59939242006-01-31 20:17:42 +00001This document contains instructions on how to build the FreeType
2library on Unix systems. This also works for emulations like Cygwin
3or MSys on Win32:
David Turner66cbc202003-03-20 07:04:40 +00004
5
Werner Lemberga16c4a72003-04-21 13:30:27 +00006 1. Ensure that you are using GNU Make
David Turner66cbc202003-03-20 07:04:40 +00007 -------------------------------------
8
Werner Lemberg59939242006-01-31 20:17:42 +00009 The FreeType build system _exclusively_ works with GNU Make. You
10 will not be able to compile the library with the instructions
11 below using any other alternative (including BSD Make).
David Turner66cbc202003-03-20 07:04:40 +000012
Werner Lemberg59939242006-01-31 20:17:42 +000013 [Well, this is not really correct. A few years ago a perl
14 implementation of make called `makepp' has appeared which can also
15 build FreeType 2 successfully on Unix platforms. See
Werner Lemberga7235262005-08-30 00:22:46 +000016
17 http://makepp.sourceforge.net
18
Werner Lemberg59939242006-01-31 20:17:42 +000019 for more details; you need version 1.19 or newer, and you must
20 pass option `--norc-substitution'.]
Werner Lemberga16c4a72003-04-21 13:30:27 +000021
Werner Lemberg59939242006-01-31 20:17:42 +000022 Trying to compile the library with a different Make tool will
23 print a message like:
David Turner66cbc202003-03-20 07:04:40 +000024
25 Sorry, GNU make is required to build FreeType2.
26
Werner Lemberg59939242006-01-31 20:17:42 +000027 and the build process will be aborted. If this happens, install
28 GNU Make on your system, and use the GNUMAKE environment variable
29 to name it, if necessary.
David Turner66cbc202003-03-20 07:04:40 +000030
31
Werner Lemberga16c4a72003-04-21 13:30:27 +000032 2. Build and install the library
33 --------------------------------
David Turner66cbc202003-03-20 07:04:40 +000034
Werner Lemberg59939242006-01-31 20:17:42 +000035 The following should work on all Unix systems where the `make'
David Turner66cbc202003-03-20 07:04:40 +000036 command invokes GNU Make:
37
Werner Lemberga16c4a72003-04-21 13:30:27 +000038 ./configure [options]
David Turner66cbc202003-03-20 07:04:40 +000039 make
40 make install (as root)
41
Werner Lemberg59939242006-01-31 20:17:42 +000042 The default installation path is `/usr/local'. It can be changed
Werner Lemberga16c4a72003-04-21 13:30:27 +000043 with the `--prefix=<path>' option. Example:
David Turner66cbc202003-03-20 07:04:40 +000044
Werner Lemberga16c4a72003-04-21 13:30:27 +000045 ./configure --prefix=/usr
46
Werner Lemberg59939242006-01-31 20:17:42 +000047 When using a different command to invoke GNU Make, use the GNUMAKE
48 variable. For example, if `gmake' is the command to use on your
David Turner66cbc202003-03-20 07:04:40 +000049 system, do something like:
50
Werner Lemberga16c4a72003-04-21 13:30:27 +000051 GNUMAKE=gmake ./configure [options]
David Turner66cbc202003-03-20 07:04:40 +000052 gmake
53 gmake install (as root)
54
Werner Lemberg59939242006-01-31 20:17:42 +000055 If this still doesn't work, there must be a problem with your
56 system (e.g., you are using a very old version of GNU Make).
Werner Lemberga16c4a72003-04-21 13:30:27 +000057
Werner Lemberg59939242006-01-31 20:17:42 +000058 It is possible to compile FreeType in a different directory.
59 Assuming the FreeType source files in directory `/src/freetype' a
Werner Lemberga16c4a72003-04-21 13:30:27 +000060 compilation in directory `foo' works as follows:
61
62 cd foo
63 /src/freetype/configure [options]
64 make
65 make install
David Turner66cbc202003-03-20 07:04:40 +000066
Werner Lemberg59939242006-01-31 20:17:42 +000067----------------------------------------------------------------------
David Turner66cbc202003-03-20 07:04:40 +000068
Werner Lemberg59939242006-01-31 20:17:42 +000069Copyright 2003, 2004, 2005, 2006 by
Werner Lemberg56c368c2005-06-04 23:00:25 +000070David Turner, Robert Wilhelm, and Werner Lemberg.
71
Werner Lemberg59939242006-01-31 20:17:42 +000072This file is part of the FreeType project, and may only be used,
73modified, and distributed under the terms of the FreeType project
74license, LICENSE.TXT. By continuing to use, modify, or distribute
75this file you indicate that you have read the license and understand
76and accept it fully.
Werner Lemberg56c368c2005-06-04 23:00:25 +000077
78
79--- end of INSTALL.UNX ---