Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 1 | Instructions on how to build FreeType with your own build tool |
| 2 | ============================================================== |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 3 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 4 | See the file `CUSTOMIZE' to learn how to customize FreeType to |
| 5 | specific environments. |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 6 | |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 7 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 8 | I. Standard procedure |
| 9 | --------------------- |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 10 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 11 | * DISABLE PRE-COMPILED HEADERS! This is very important for Visual |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 12 | C++, because FreeType uses lines like: |
Werner Lemberg | 9b774e2 | 2007-01-16 06:11:27 +0000 | [diff] [blame] | 13 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 14 | #include FT_FREETYPE_H |
Werner Lemberg | 9b774e2 | 2007-01-16 06:11:27 +0000 | [diff] [blame] | 15 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 16 | which are not correctly supported by this compiler while being ISO |
| 17 | C compliant! |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 18 | |
Werner Lemberg | 8502c98 | 2015-06-22 06:35:23 +0200 | [diff] [blame] | 19 | * You need to add the directory `include' to your include path when |
| 20 | compiling the library. |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 21 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 22 | * FreeType 2 is made of several components; each of them is located |
| 23 | in a subdirectory of `freetype2/src'. For example, |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 24 | `freetype2/src/truetype/' contains the TrueType font driver. |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 25 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 26 | * DO NOT COMPILE ALL C FILES! Rather, compile the following ones. |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 27 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 28 | -- base components (required) |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 29 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 30 | src/base/ftsystem.c |
| 31 | src/base/ftinit.c |
| 32 | src/base/ftdebug.c |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 33 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 34 | src/base/ftbase.c |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 35 | |
Werner Lemberg | fae3820 | 2013-11-13 08:55:46 +0100 | [diff] [blame] | 36 | src/base/ftbbox.c -- recommended, see <ftbbox.h> |
| 37 | src/base/ftglyph.c -- recommended, see <ftglyph.h> |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 38 | |
Werner Lemberg | fae3820 | 2013-11-13 08:55:46 +0100 | [diff] [blame] | 39 | src/base/ftbdf.c -- optional, see <ftbdf.h> |
| 40 | src/base/ftbitmap.c -- optional, see <ftbitmap.h> |
| 41 | src/base/ftcid.c -- optional, see <ftcid.h> |
Werner Lemberg | 0633995 | 2015-03-11 06:30:23 +0100 | [diff] [blame] | 42 | src/base/ftfntfmt.c -- optional, see <ftfntfmt.h> |
Werner Lemberg | 5184ed6 | 2009-01-22 10:13:59 +0000 | [diff] [blame] | 43 | src/base/ftfstype.c -- optional |
Werner Lemberg | fae3820 | 2013-11-13 08:55:46 +0100 | [diff] [blame] | 44 | src/base/ftgasp.c -- optional, see <ftgasp.h> |
| 45 | src/base/ftgxval.c -- optional, see <ftgxval.h> |
| 46 | src/base/ftlcdfil.c -- optional, see <ftlcdfil.h> |
| 47 | src/base/ftmm.c -- optional, see <ftmm.h> |
| 48 | src/base/ftotval.c -- optional, see <ftotval.h> |
Werner Lemberg | 5184ed6 | 2009-01-22 10:13:59 +0000 | [diff] [blame] | 49 | src/base/ftpatent.c -- optional |
Werner Lemberg | fae3820 | 2013-11-13 08:55:46 +0100 | [diff] [blame] | 50 | src/base/ftpfr.c -- optional, see <ftpfr.h> |
| 51 | src/base/ftstroke.c -- optional, see <ftstroke.h> |
| 52 | src/base/ftsynth.c -- optional, see <ftsynth.h> |
| 53 | src/base/fttype1.c -- optional, see <t1tables.h> |
| 54 | src/base/ftwinfnt.c -- optional, see <ftwinfnt.h> |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 55 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 56 | src/base/ftmac.c -- only on the Macintosh |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 57 | |
Werner Lemberg | 2b428d5 | 2005-10-15 05:49:31 +0000 | [diff] [blame] | 58 | -- font drivers (optional; at least one is needed) |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 59 | |
| 60 | src/bdf/bdf.c -- BDF font driver |
| 61 | src/cff/cff.c -- CFF/OpenType font driver |
| 62 | src/cid/type1cid.c -- Type 1 CID-keyed font driver |
| 63 | src/pcf/pcf.c -- PCF font driver |
| 64 | src/pfr/pfr.c -- PFR/TrueDoc font driver |
| 65 | src/sfnt/sfnt.c -- SFNT files support |
| 66 | (TrueType & OpenType) |
| 67 | src/truetype/truetype.c -- TrueType font driver |
| 68 | src/type1/type1.c -- Type 1 font driver |
| 69 | src/type42/type42.c -- Type 42 font driver |
Werner Lemberg | 8b56063 | 2006-01-19 08:30:58 +0000 | [diff] [blame] | 70 | src/winfonts/winfnt.c -- Windows FONT / FNT font driver |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 71 | |
Werner Lemberg | 5184ed6 | 2009-01-22 10:13:59 +0000 | [diff] [blame] | 72 | -- rasterizers (optional; at least one is needed for vector |
| 73 | formats) |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 74 | |
Werner Lemberg | 2b428d5 | 2005-10-15 05:49:31 +0000 | [diff] [blame] | 75 | src/raster/raster.c -- monochrome rasterizer |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 76 | src/smooth/smooth.c -- anti-aliasing rasterizer |
| 77 | |
| 78 | -- auxiliary modules (optional) |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 79 | |
Werner Lemberg | a37745b | 2005-03-23 16:45:24 +0000 | [diff] [blame] | 80 | src/autofit/autofit.c -- auto hinting module |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 81 | src/cache/ftcache.c -- cache sub-system (in beta) |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 82 | src/gzip/ftgzip.c -- support for compressed fonts (.gz) |
| 83 | src/lzw/ftlzw.c -- support for compressed fonts (.Z) |
Werner Lemberg | fe42a65 | 2010-12-31 17:47:09 +0100 | [diff] [blame] | 84 | src/bzip2/ftbzip2.c -- support for compressed fonts (.bz2) |
Suzuki, Toshiya (鈴木俊哉) | a438621 | 2005-08-24 04:31:31 +0000 | [diff] [blame] | 85 | src/gxvalid/gxvalid.c -- TrueTypeGX/AAT table validation |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 86 | src/otvalid/otvalid.c -- OpenType table validation |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 87 | src/psaux/psaux.c -- PostScript Type 1 parsing |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 88 | src/pshinter/pshinter.c -- PS hinting module |
| 89 | src/psnames/psnames.c -- PostScript glyph names support |
| 90 | |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 91 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 92 | Notes: |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 93 | |
Werner Lemberg | 5184ed6 | 2009-01-22 10:13:59 +0000 | [diff] [blame] | 94 | `ftcache.c' needs `ftglyph.c' |
| 95 | `ftfstype.c' needs `fttype1.c' |
| 96 | `ftglyph.c' needs `ftbitmap.c' |
| 97 | `ftstroke.c' needs `ftglyph.c' |
| 98 | `ftsynth.c' needs `ftbitmap.c' |
| 99 | |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 100 | `cff.c' needs `sfnt.c', `pshinter.c', and `psnames.c' |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 101 | `truetype.c' needs `sfnt.c' and `psnames.c' |
Werner Lemberg | f20a4d3 | 2005-08-10 13:24:51 +0000 | [diff] [blame] | 102 | `type1.c' needs `psaux.c' `pshinter.c', and `psnames.c' |
| 103 | `type1cid.c' needs `psaux.c', `pshinter.c', and `psnames.c' |
| 104 | `type42.c' needs `truetype.c' |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 105 | |
Werner Lemberg | 392cf22 | 2015-06-25 13:04:57 +0200 | [diff] [blame] | 106 | Please consult the central `include/freetype/config/ftoption.h' |
Werner Lemberg | 9ada669 | 2015-02-07 08:22:00 +0100 | [diff] [blame] | 107 | configuration file for details on additional libraries necessary |
| 108 | for some optional features. |
Werner Lemberg | fe42a65 | 2010-12-31 17:47:09 +0100 | [diff] [blame] | 109 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 110 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 111 | Read the file `CUSTOMIZE' in case you want to compile only a subset |
| 112 | of the drivers, renderers, and optional modules; a detailed |
| 113 | description of the various base extension is given in the top-level |
| 114 | file `modules.cfg'. |
Werner Lemberg | a723526 | 2005-08-30 00:22:46 +0000 | [diff] [blame] | 115 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 116 | You are done. In case of problems, see the archives of the FreeType |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 117 | development mailing list. |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 118 | |
| 119 | |
| 120 | II. Support for flat-directory compilation |
| 121 | ------------------------------------------ |
| 122 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 123 | It is possible to put all FreeType 2 source files into a single |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 124 | directory, with the *exception* of the `include' hierarchy. |
| 125 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 126 | 1. Copy all files in current directory |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 127 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 128 | cp freetype2/src/base/*.[hc] . |
| 129 | cp freetype2/src/raster1/*.[hc] . |
| 130 | cp freetype2/src/smooth/*.[hc] . |
| 131 | etc. |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 132 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 133 | 2. Compile sources |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 134 | |
Werner Lemberg | 8502c98 | 2015-06-22 06:35:23 +0200 | [diff] [blame] | 135 | cc -c -Iinclude -DFT2_BUILD_LIBRARY ftsystem.c |
| 136 | cc -c -Iinclude -DFT2_BUILD_LIBRARY ftinit.c |
| 137 | cc -c -Iinclude -DFT2_BUILD_LIBRARY ftdebug.c |
| 138 | cc -c -Iinclude -DFT2_BUILD_LIBRARY ftbase.c |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 139 | etc. |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 140 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 141 | You don't need to define the FT_FLAT_COMPILATION macro (as this |
| 142 | was required in previous releases of FreeType 2). |
David Turner | 66cbc20 | 2003-03-20 07:04:40 +0000 | [diff] [blame] | 143 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 144 | ---------------------------------------------------------------------- |
Werner Lemberg | 56c368c | 2005-06-04 23:00:25 +0000 | [diff] [blame] | 145 | |
Werner Lemberg | f57fc59 | 2015-01-17 20:41:43 +0100 | [diff] [blame] | 146 | Copyright 2003-2015 by |
Werner Lemberg | 56c368c | 2005-06-04 23:00:25 +0000 | [diff] [blame] | 147 | David Turner, Robert Wilhelm, and Werner Lemberg. |
| 148 | |
Werner Lemberg | 5993924 | 2006-01-31 20:17:42 +0000 | [diff] [blame] | 149 | This file is part of the FreeType project, and may only be used, |
| 150 | modified, and distributed under the terms of the FreeType project |
| 151 | license, LICENSE.TXT. By continuing to use, modify, or distribute |
| 152 | this file you indicate that you have read the license and understand |
| 153 | and accept it fully. |
Werner Lemberg | 56c368c | 2005-06-04 23:00:25 +0000 | [diff] [blame] | 154 | |
Werner Lemberg | a16c4a7 | 2003-04-21 13:30:27 +0000 | [diff] [blame] | 155 | |
| 156 | --- end of INSTALL.ANY --- |