blob: f6deea8c7ff8b7cdb774b11989463de59f8d569c [file] [log] [blame]
David Turner66cbc202003-03-20 07:04:40 +00001This document contains instructions on how to build the FreeType library
Werner Lemberga7235262005-08-30 00:22:46 +00002on Unix systems. This also works for emulations like Cygwin or MSys on
David Turner66cbc202003-03-20 07:04:40 +00003Win32:
4
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 Lemberga16c4a72003-04-21 13:30:27 +00009 The FreeType build system _exclusively_ works with GNU Make. You
10 will not be able to compile the library with the instructions below
11 using any other alternative (including BSD Make).
David Turner66cbc202003-03-20 07:04:40 +000012
Werner Lemberga16c4a72003-04-21 13:30:27 +000013 [Well, this is not really correct. Recently, a perl implementation
14 of make called `makepp' has appeared which can also build FreeType 2
Werner Lemberga7235262005-08-30 00:22:46 +000015 successfully on Unix platforms. See
16
17 http://makepp.sourceforge.net
18
19 for more details; you need version 1.19 or newer, and you must pass
Werner Lemberg26eccb42004-04-13 08:35:05 +000020 option `--norc-substitution'.]
Werner Lemberga16c4a72003-04-21 13:30:27 +000021
22 Trying to compile the library with a different Make tool will print
23 a message like:
David Turner66cbc202003-03-20 07:04:40 +000024
25 Sorry, GNU make is required to build FreeType2.
26
Werner Lemberga16c4a72003-04-21 13:30:27 +000027 and the build process will be aborted. If this happens, install GNU
28 Make on your system, and use the GNUMAKE environment variable to
29 name it.
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 Lemberga16c4a72003-04-21 13:30:27 +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 Lemberga7235262005-08-30 00:22:46 +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
47 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 Lemberga7235262005-08-30 00:22:46 +000055 If this still doesn't work, there must be a problem with your system
56 (e.g., you are using a very old version of GNU Make).
Werner Lemberga16c4a72003-04-21 13:30:27 +000057
58 It is possible to compile FreeType in a different directory.
59 Assuming the FreeType source files in directory `/src/freetype' a
60 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 Lemberg56c368c2005-06-04 23:00:25 +000067------------------------------------------------------------------------
David Turner66cbc202003-03-20 07:04:40 +000068
Werner Lemberga7235262005-08-30 00:22:46 +000069Copyright 2003, 2004, 2005 by
Werner Lemberg56c368c2005-06-04 23:00:25 +000070David Turner, Robert Wilhelm, and Werner Lemberg.
71
Werner Lemberga7235262005-08-30 00:22:46 +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 this
75file you indicate that you have read the license and understand and
Werner Lemberg56c368c2005-06-04 23:00:25 +000076accept it fully.
77
78
79--- end of INSTALL.UNX ---