Imported Upstream version 2.13.2
[platform/upstream/freetype2.git] / README
1 FreeType 2.13.2
2 ===============
3
4 Homepage: https://www.freetype.org
5
6 FreeType is a freely available software library to render fonts.
7
8 It  is  written  in  C,   designed  to  be  small,  efficient,  highly
9 customizable,  and portable  while capable  of producing  high-quality
10 output (glyph images) of most vector and bitmap font formats.
11
12 Please   read  the   `docs/CHANGES`   file,   it  contains   IMPORTANT
13 INFORMATION.
14
15 Read the files `docs/INSTALL*`  for installation instructions; see the
16 file `docs/LICENSE.TXT` for the available licenses.
17
18 For using FreeType's git repository  instead of a distribution bundle,
19 please read file  `README.git`.  Note that you have  to actually clone
20 the repository; using a snapshot will  not work (in other words, don't
21 use gitlab's 'Download' button).
22
23 The FreeType 2 API reference is located in directory `docs/reference`;
24 use the file  `index.html` as the top entry point.   [Please note that
25 currently  the search  function  for  locally installed  documentation
26 doesn't work due to cross-site scripting issues.]
27
28 Additional documentation is  available as a separate  package from our
29 sites.  Go to
30
31   https://download.savannah.gnu.org/releases/freetype/
32
33 and download one of the following files.
34
35   freetype-doc-2.13.2.tar.xz
36   freetype-doc-2.13.2.tar.gz
37   ftdoc2132.zip
38
39 To view the documentation online, go to
40
41   https://www.freetype.org/freetype2/docs/
42
43
44 Mailing Lists
45 -------------
46
47 The preferred  way of  communication with the  FreeType team  is using
48 e-mail lists.
49
50   general use and discussion:      freetype@nongnu.org
51   engine internals, porting, etc.: freetype-devel@nongnu.org
52   announcements:                   freetype-announce@nongnu.org
53   git repository tracker:          freetype-commit@nongnu.org
54
55 The lists are moderated; see
56
57   https://www.freetype.org/contact.html
58
59 how to subscribe.
60
61
62 Bugs
63 ----
64
65 Please submit bug reports at
66
67   https://gitlab.freedesktop.org/freetype/freetype/-/issues
68
69 Alternatively,    you    might    report    bugs    by    e-mail    to
70 `freetype-devel@nongnu.org`.    Don't  forget   to  send   a  detailed
71 explanation of the problem -- there  is nothing worse than receiving a
72 terse message that only says 'it doesn't work'.
73
74
75 Patches
76 -------
77
78 For larger changes please provide merge requests at
79
80   https://gitlab.freedesktop.org/freetype/freetype/-/merge_requests
81
82 Alternatively, you can send patches to the `freetype-devel@nongnu.org`
83 mailing list  -- and thank you  in advance for your  work on improving
84 FreeType!
85
86 Details on the process can be found here:
87
88   https://www.freetype.org/developer.html#patches
89
90
91 Enjoy!
92
93   The FreeType Team
94
95 ----------------------------------------------------------------------
96
97 Copyright (C) 2006-2023 by
98 David Turner, Robert Wilhelm, and Werner Lemberg.
99
100 This  file is  part of  the FreeType  project, and  may only  be used,
101 modified,  and distributed  under the  terms of  the  FreeType project
102 license,  LICENSE.TXT.  By  continuing to  use, modify,  or distribute
103 this file you  indicate that you have read  the license and understand
104 and accept it fully.
105
106
107 --- end of README ---