freetype-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Git][freetype/freetype][master] Improve build documentation.


From: Werner Lemberg
Subject: [Git][freetype/freetype][master] Improve build documentation.
Date: Sat, 27 Feb 2021 10:06:52 +0000

Werner Lemberg pushed to branch master at FreeType / FreeType

Commits:

3 changed files:

Changes:

  • README
    ... ... @@ -15,6 +15,9 @@ INFORMATION.
    15 15
     Read the files `docs/INSTALL*`  for installation instructions; see the
    
    16 16
     file `docs/LICENSE.TXT` for the available licenses.
    
    17 17
     
    
    18
    +For using FreeType's git repository  instead of a distribution bundle,
    
    19
    +please read file `README.git`.
    
    20
    +
    
    18 21
     The FreeType 2 API reference is located in directory `docs/reference`;
    
    19 22
     use the file  `index.html` as the top entry point.   [Please note that
    
    20 23
     currently  the search  function  for  locally installed  documentation
    

  • docs/INSTALL
    ... ... @@ -7,7 +7,19 @@ overview of the documentation available:
    7 7
     I. Normal installation and upgrades
    
    8 8
     ===================================
    
    9 9
     
    
    10
    -  1. Unix Systems (including Mac OS X, Cygwin, and MSys on Windows)
    
    10
    +  0. Modify  `include/freetype/config/ftoption.h',  if  necessary,  to
    
    11
    +     control how the FreeType library gets built.  Normally, you don't
    
    12
    +     need to change anything.
    
    13
    +
    
    14
    +     Applications can't  control FreeType's  behaviour at  build time.
    
    15
    +     To make  applications control  (some of) FreeType's  behaviour at
    
    16
    +     run-time,    look    at    the    documentation    of    function
    
    17
    +     `FT_Property_Set'.
    
    18
    +
    
    19
    +  1. Unix and Unix-like systems
    
    20
    +
    
    21
    +    This also includes MacOS, Cygwin, MinGW + MSYS, Mingw-w64 + MSYS2,
    
    22
    +    and possibly other, similar environments.
    
    11 23
     
    
    12 24
         Please read `INSTALL.UNIX' to install or upgrade FreeType  2 on  a
    
    13 25
         Unix system.   Note  that  you  *need*  GNU  Make   for  automatic
    
    ... ... @@ -26,10 +38,11 @@ I. Normal installation and upgrades
    26 38
     
    
    27 39
       3. Other systems using GNU Make
    
    28 40
     
    
    29
    -    On non-Unix platforms,  it is possible to build  the library using
    
    30
    -    GNU Make  utility.  Note that  *NO OTHER MAKE TOOL  WILL WORK*[1]!
    
    31
    -    This  methods supports  several  compilers on  Windows, OS/2,  and
    
    32
    -    BeOS, including MinGW, Visual C++, Borland C++, and more.
    
    41
    +    On some  non-Unix platforms, it  is possible to build  the library
    
    42
    +    using only  the GNU Make utility.   Note that *NO OTHER  MAKE TOOL
    
    43
    +    WILL  WORK*[1]!   This  methods   supports  several  compilers  on
    
    44
    +    Windows, OS/2, and BeOS,  including MinGW* (without MSYS*), Visual
    
    45
    +    C++, Borland C++, and more.
    
    33 46
     
    
    34 47
         Instructions are provided in the file `INSTALL.GNU'.
    
    35 48
     
    

  • docs/INSTALL.UNIX
    ... ... @@ -44,14 +44,21 @@ or MSys on Win32:
    44 44
     
    
    45 45
           sh autogen.sh
    
    46 46
     
    
    47
    -    In case of problems, you  may need to install or upgrade Automake,
    
    48
    -    Autoconf or  Libtool.  See  README.git in the  top-level directory
    
    47
    +    In case of problems, you may  need to install or upgrade Automake,
    
    48
    +    Autoconf or Libtool.  See  `README.git' in the top-level directory
    
    49 49
         for more information.
    
    50 50
     
    
    51 51
     
    
    52 52
       3. Build and install the library
    
    53 53
       --------------------------------
    
    54 54
     
    
    55
    +    Say
    
    56
    +
    
    57
    +      ./configure --help
    
    58
    +
    
    59
    +    to see  the list of  possible configuration options  and important
    
    60
    +    environment variables.
    
    61
    +
    
    55 62
         The following  should work  on all Unix  systems where  the `make'
    
    56 63
         command invokes GNU Make:
    
    57 64
     
    
    ... ... @@ -75,6 +82,18 @@ or MSys on Win32:
    75 82
         If  this still doesn't  work, there  must be  a problem  with your
    
    76 83
         system (e.g., you are using a very old version of GNU Make).
    
    77 84
     
    
    85
    +    For library identification, FreeType's `configure' script uses the
    
    86
    +    `pkg-config' interface: Assuming it  needs library `foo', it calls
    
    87
    +    the  `pkg-config' program  to find  information on  library `foo',
    
    88
    +    which in turn  looks for a `foo.pc' file installed  at the system.
    
    89
    +    Some platforms,  however, don't come with  `pkg-support'; you then
    
    90
    +    have  to  use environment  variables  as  described by  `configure
    
    91
    +    --help'.  Example:
    
    92
    +
    
    93
    +      LIBPNG_CFLAGS="-I/path/to/libpng/include/directory" \
    
    94
    +      LIBPNG_LIBS="-L/path/to/libpng/lib/directory" \
    
    95
    +      configure ...
    
    96
    +
    
    78 97
         It  is possible  to  compile FreeType  in  a different  directory.
    
    79 98
         Assuming the FreeType source  files in directory `/src/freetype' a
    
    80 99
         compilation in directory `foo' works as follows:
    


  • reply via email to

    [Prev in Thread] Current Thread [Next in Thread]