modules/freetype2/docs/INSTALL.GNU

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/modules/freetype2/docs/INSTALL.GNU	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,161 @@
     1.4 +This document contains instructions how  to build the FreeType library
     1.5 +on non-Unix systems with  the help of GNU Make.  Note  that if you are
     1.6 +running  Cygwin  or  MinGW/MSYS  in Windows,  you  should  follow  the
     1.7 +instructions in the file `INSTALL.UNIX' instead.
     1.8 +
     1.9 +
    1.10 +  FreeType 2 includes a powerful and flexible build system that allows
    1.11 +  you to  easily compile it on  a great variety of  platforms from the
    1.12 +  command line.  To do so, just follow these simple instructions.
    1.13 +
    1.14 +  1. Install GNU Make
    1.15 +  -------------------
    1.16 +
    1.17 +    Because  GNU Make  is  the  only Make  tool  supported to  compile
    1.18 +    FreeType 2, you should install it on your machine.
    1.19 +
    1.20 +    The FreeType 2 build system relies on many features special to GNU
    1.21 +    Make.
    1.22 +
    1.23 +    NEARLY ALL OTHER MAKE TOOLS  FAIL, INCLUDING `BSD MAKE', SO REALLY
    1.24 +    INSTALL A RECENT VERSION OF GNU MAKE ON YOUR SYSTEM!
    1.25 +
    1.26 +    Note that  make++, a  make tool written  in Perl,  supports enough
    1.27 +    features of GNU make to compile FreeType.  See
    1.28 +
    1.29 +      http://makepp.sourceforge.net
    1.30 +
    1.31 +    for more information; you need version 1.19 or newer, and you must
    1.32 +    pass option `--norc-substitution'.
    1.33 +
    1.34 +    Make sure that you are invoking GNU Make from the command line, by
    1.35 +    typing something like:
    1.36 +
    1.37 +      make -v
    1.38 +
    1.39 +    to display its version number.
    1.40 +
    1.41 +    VERSION 3.80 OR NEWER IS NEEDED!
    1.42 +
    1.43 +
    1.44 +  2. Invoke `make'
    1.45 +  ----------------
    1.46 +
    1.47 +    Go to  the root  directory of FreeType  2, then simply  invoke GNU
    1.48 +    Make from the command line.   This will launch the FreeType 2 host
    1.49 +    platform  detection routines.   A summary  will be  displayed, for
    1.50 +    example, on Win32.
    1.51 +
    1.52 +
    1.53 +      ==============================================================
    1.54 +      FreeType build system -- automatic system detection
    1.55 +
    1.56 +      The following settings are used:
    1.57 +
    1.58 +        platform                     windows
    1.59 +        compiler                     gcc
    1.60 +        configuration directory      .\builds\windows
    1.61 +        configuration rules          .\builds\windows\w32-gcc.mk
    1.62 +
    1.63 +      If this does not correspond to your system or settings please
    1.64 +      remove the file 'config.mk' from this directory then read the
    1.65 +      INSTALL file for help.
    1.66 +
    1.67 +      Otherwise, simply type 'make' again to build the library
    1.68 +      or 'make refdoc' to build the API reference (the latter needs
    1.69 +      python).
    1.70 +      =============================================================
    1.71 +
    1.72 +
    1.73 +    If the detected settings correspond to your platform and compiler,
    1.74 +    skip to step 5.  Note that if your platform is completely alien to
    1.75 +    the build system, the detected platform will be `ansi'.
    1.76 +
    1.77 +
    1.78 +  3. Configure the build system for a different compiler
    1.79 +  ------------------------------------------------------
    1.80 +
    1.81 +    If the build system correctly detected your platform, but you want
    1.82 +    to use a different compiler  than the one specified in the summary
    1.83 +    (for most platforms, gcc is the default compiler), invoke GNU Make
    1.84 +    with
    1.85 +
    1.86 +      make setup <compiler>
    1.87 +
    1.88 +    Examples:
    1.89 +
    1.90 +      to use Visual C++ on Win32, type:  `make setup visualc'
    1.91 +      to use Borland C++ on Win32, type  `make setup bcc32'
    1.92 +      to use Watcom C++ on Win32, type   `make setup watcom'
    1.93 +      to use Intel C++ on Win32, type    `make setup intelc'
    1.94 +      to use LCC-Win32 on Win32, type:   `make setup lcc'
    1.95 +      to use Watcom C++ on OS/2, type    `make setup watcom'
    1.96 +      to use VisualAge C++ on OS/2, type `make setup visualage'
    1.97 +
    1.98 +    The  <compiler> name to  use is  platform-dependent.  The  list of
    1.99 +    available  compilers for  your  system is  available  in the  file
   1.100 +    `builds/<system>/detect.mk'.
   1.101 +
   1.102 +    If you  are satisfied  by the new  configuration summary,  skip to
   1.103 +    step 5.
   1.104 +
   1.105 +
   1.106 +  4. Configure the build system for an unknown platform/compiler
   1.107 +  --------------------------------------------------------------
   1.108 +
   1.109 +    The auto-detection/setup  phase of the build system  copies a file
   1.110 +    to the current directory under the name `config.mk'.
   1.111 +
   1.112 +    For    example,    on    OS/2+gcc,    it   would    simply    copy
   1.113 +    `builds/os2/os2-gcc.mk' to `./config.mk'.
   1.114 +
   1.115 +    If for  some reason your  platform isn't correctly  detected, copy
   1.116 +    manually the configuration sub-makefile to `./config.mk' and go to
   1.117 +    step 5.
   1.118 +
   1.119 +    Note  that  this file  is  a  sub-Makefile  used to  specify  Make
   1.120 +    variables  for compiler  and linker  invocation during  the build.
   1.121 +    You can  easily create your own  version from one  of the existing
   1.122 +    configuration files,  then copy it to the  current directory under
   1.123 +    the name `./config.mk'.
   1.124 +
   1.125 +
   1.126 +  5. Build the library
   1.127 +  --------------------
   1.128 +
   1.129 +    The auto-detection/setup  phase should have  copied a file  in the
   1.130 +    current  directory,  called  `./config.mk'.   This  file  contains
   1.131 +    definitions of various Make  variables used to invoke the compiler
   1.132 +    and linker during the build.  [It has also generated a file called
   1.133 +    `ftmodule.h'   in  the  objects   directory  (which   is  normally
   1.134 +    `<toplevel>/objs/');  please read  the  file `docs/CUSTOMIZE'  for
   1.135 +    customization of FreeType.]
   1.136 +
   1.137 +    To  launch  the build,  simply  invoke  GNU  Make again:  The  top
   1.138 +    Makefile will detect the configuration file and run the build with
   1.139 +    it.
   1.140 +
   1.141 +
   1.142 +  Final note
   1.143 +
   1.144 +    The above instructions build a  _statically_ linked library of the
   1.145 +    font engine in the `objs' directory.   On Windows, you can build a
   1.146 +    DLL  either  with  MinGW  (within an  MSYS  shell,  following  the
   1.147 +    instructions in `INSTALL.UNIX'), or you  use one of the Visual C++
   1.148 +    project files; see  the  subdirectories  of `builds/windows'.  For
   1.149 +    everything else,  you are on  your own,  and you might  follow the
   1.150 +    instructions in `INSTALL.ANY' to create your own Makefiles.
   1.151 +
   1.152 +----------------------------------------------------------------------
   1.153 +
   1.154 +Copyright 2003-2006, 2008, 2013, 2014 by
   1.155 +David Turner, Robert Wilhelm, and Werner Lemberg.
   1.156 +
   1.157 +This  file is  part of  the FreeType  project, and  may only  be used,
   1.158 +modified,  and distributed  under the  terms of  the  FreeType project
   1.159 +license,  LICENSE.TXT.  By  continuing to  use, modify,  or distribute
   1.160 +this file you  indicate that you have read  the license and understand
   1.161 +and accept it fully.
   1.162 +
   1.163 +
   1.164 +--- end of INSTALL.GNU ---

mercurial