docs/INSTALL

   1
   2 There are  several ways  to build the  FreeType library,  depending on
   3 your system and the level of  customization you need.  Here is a short
   4 overview of the documentation available:
   5
   6
   7 I. Normal installation and upgrades
   8 ===================================
   9
  10   1. Unix Systems (including Mac OS X, Cygwin, and MSys on Windows)
  11
  12     Please read `INSTALL.UNIX' to install or upgrade FreeType  2 on  a
  13     Unix system.   Note  that  you  *need*  GNU  Make   for  automatic
  14     compilation,  since other make tools won't work (this includes BSD
  15     Make).
  16
  17     GNU Make VERSION 3.80 OR NEWER IS NEEDED!
  18
  19
  20   2. On VMS with the `mms' build tool
  21
  22     See `INSTALL.VMS' for installation instructions on this platform.
  23
  24
  25   3. Other systems using GNU Make
  26
  27     On non-Unix platforms,  it is possible to build  the library using
  28     GNU Make  utility.  Note that  *NO OTHER MAKE TOOL  WILL WORK*[1]!
  29     This  methods supports  several  compilers on  Windows, OS/2,  and
  30     BeOS, including MinGW, Visual C++, Borland C++, and more.
  31
  32     Instructions are provided in the file `INSTALL.GNU'.
  33
  34
  35   4. With an IDE Project File (e.g., for Visual Studio or CodeWarrior)
  36
  37     We provide a  small number of `project files'  for various IDEs to
  38     automatically build  the library as  well.  Note that  these files
  39     are  not supported  and only  sporadically maintained  by FreeType
  40     developers, so don't expect them to work in each release.
  41
  42     To find them, have a  look at the content of the `builds/<system>'
  43     directory, where <system> stands for your OS or environment.
  44
  45
  46   5. Using cmake
  47
  48     See the top-level `CMakeLists.txt' file for more information.
  49
  50
  51   6. From you own IDE, or own Makefiles
  52
  53     If  you  want  to  create   your  own  project  file,  follow  the
  54     instructions   given  in  the   `INSTALL.ANY'  document   of  this
  55     directory.
  56
  57
  58 II. Custom builds of the library
  59 ================================
  60
  61   Customizing the compilation  of FreeType is easy, and  allows you to
  62   select only the components of  the font engine that you really need.
  63   For more details read the file `CUSTOMIZE'.
  64
  65
  66 ----------------------------------------------------------------------
  67
  68 [1] make++, a make tool written in Perl, has sufficient support of GNU
  69     make extensions to build FreeType.  See
  70
  71       http://makepp.sourceforge.net
  72
  73     for more information; you need version 1.19 or newer, and you must
  74     pass option `--norc-substitution'.
  75
  76 ----------------------------------------------------------------------
  77
  78 Copyright   2000-2008, 2010-2011, 2013
  79 by David Turner, Robert Wilhelm, and Werner Lemberg.
  80
  81 This  file is  part of  the FreeType  project, and  may only  be used,
  82 modified,  and distributed  under the  terms of  the  FreeType project
  83 license,  LICENSE.TXT.  By  continuing to  use, modify,  or distribute
  84 this file you  indicate that you have read  the license and understand
  85 and accept it fully.
  86
  87
  88 --- end of INSTALL ---