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