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