Synchronize with FreeType.
[ttfautohint.git] / README
1 ttfautohint 1.8.1
2 -----------------
4 by Werner Lemberg <>
7 This project provides a library that takes a TrueType font as the input,
8 removes its bytecode instructions (if any), and returns a new font where all
9 glyphs are bytecode hinted using the information given by FreeType's
10 auto-hinting module.  The idea is to provide the excellent quality of the
11 auto-hinter on platforms that don't use FreeType.
13 The library has a single API function, `TTF_autohint'; see
14 `lib/ttfautohint.h' for a detailed description.  Note that the library
15 itself won't get installed currently.
17 A command-line interface to the library is the `ttfautohint' program; after
18 compilation and installation, say
20   ttfautohint --help
22 for usage information, or say
24   man ttfautohint
26 to read its manual page.
28 A GUI to the library is `ttfautohintGUI'; it uses the Qt4 framework.  The
29 compilation of this application can be disabled with the `--without-qt'
30 option of the `configure' script.
32 -----------------------------------------------------------------------------
34 Copyright (C) 2011-2018 by Werner Lemberg.
36 This file is part of the ttfautohint library, and may only be used,
37 modified, and distributed under the terms given in `COPYING'.  By
38 continuing to use, modify, or distribute this file you indicate that you
39 have read `COPYING' and understand and accept it fully.
41 The file `COPYING' mentioned in the previous paragraph is distributed
42 with the ttfautohint library.
44 EOF