modules/freetype2/README.git

   1 README.git
   2 ==========
   3
   4
   5 repository issues
   6 -----------------
   7
   8 FreeType's official repository site is
   9
  10   https://gitlab.freedesktop.org/freetype  ,
  11
  12 from  which the  'freetype.git' and  'freetype-demos.git' repositories
  13 can be cloned in the usual way.
  14
  15   git clone https://gitlab.freedesktop.org/freetype/freetype.git
  16   git clone https://gitlab.freedesktop.org/freetype/freetype-demos.git
  17
  18 If you  want to  use the  Savannah mirror  instead, you  have to  do a
  19 slightly different  incantation because  the repository  names contain
  20 digit '2' for historical reasons.
  21
  22   git clone \
  23     https://git.savannah.nongnu.org/git/freetype/freetype2.git \
  24     freetype
  25   git clone \
  26     https://git.savannah.nongnu.org/git/freetype/freetype2-demos.git \
  27     freetype-demos
  28
  29
  30 standard builds with `configure`
  31 --------------------------------
  32
  33 The git repository doesn't contain pre-built configuration scripts for
  34 UNIXish platforms.  To generate them say
  35
  36   sh autogen.sh
  37
  38 which in turn depends on the following packages:
  39
  40   automake (1.10.1)
  41   libtool (2.2.4)
  42   autoconf (2.62)
  43
  44 The versions given  in parentheses are known to  work.  Newer versions
  45 should  work too,  of course.   Note  that `autogen.sh`  also sets  up
  46 proper file permissions for the `configure` and auxiliary scripts.
  47
  48 The `autogen.sh` script checks whether the versions of the above three
  49 tools match the numbers above.  Otherwise it will complain and suggest
  50 either  upgrading or  using  environment variables  to  point to  more
  51 recent versions of the required tools.
  52
  53 Note that  `aclocal` is provided  by the 'automake' package  on Linux,
  54 and that `libtoolize` is called `glibtoolize` on Darwin (OS X).
  55
  56
  57 alternative build methods
  58 -------------------------
  59
  60 For static  builds that don't use  platform-specific optimizations, no
  61 configure script is necessary at all; saying
  62
  63   make setup ansi
  64   make
  65
  66 should work on all platforms that have GNU `make` (or `makepp`).
  67
  68 A build  with `cmake`  or `meson`  can be done  directly from  the git
  69 repository.  However, if you want  to use the `FT_DEBUG_LOGGING` macro
  70 (see file `docs/DEBUG` for more information) it is currently mandatory
  71 to execute `autogen.sh`  in advance; this script clones  the 'dlg' git
  72 submodule and copies some files into FreeType's source tree.
  73
  74
  75 Code of Conduct
  76 ---------------
  77
  78 Please note that  this project is released with a  Contributor Code of
  79 Conduct (CoC).  By participating in this project you agree to abide by
  80 its terms, which you can find in the following link:
  81
  82   https://www.freedesktop.org/wiki/CodeOfConduct
  83
  84 CoC issues may  be raised to the project maintainers  at the following
  85 address:
  86
  87   wl@gnu.org
  88   apodtele@gmail.com
  89
  90 ----------------------------------------------------------------------
  91
  92 Copyright (C) 2005-2023 by
  93 David Turner, Robert Wilhelm, and Werner Lemberg.
  94
  95 This  file is  part of  the FreeType  project, and  may only  be used,
  96 modified,  and distributed  under the  terms of  the  FreeType project
  97 license,  LICENSE.TXT.  By  continuing to  use, modify,  or distribute
  98 this file you  indicate that you have read  the license and understand
  99 and accept it fully.
 100
 101
 102 --- end of README.git ---