Whitespace.
[ttfautohint.git] / doc / ttfautohint-3.pandoc
blobf749153128bea34d967d46a2fb3236e5e4600354
1 <!--
2   Copyright (C) 2011-2014 by Werner Lemberg.
4   This file is part of the ttfautohint library, and may only be used,
5   modified, and distributed under the terms given in `COPYING'.  By
6   continuing to use, modify, or distribute this file you indicate that you
7   have read `COPYING' and understand and accept it fully.
9   The file `COPYING' mentioned in the previous paragraph is distributed
10   with the ttfautohint library.
11 -->
15 Compilation and Installation
16 ============================
18 Please read the files
19 [`INSTALL`](http://repo.or.cz/w/ttfautohint.git/blob_plain/HEAD:/INSTALL)
20 and
21 [`INSTALL.git`](http://repo.or.cz/w/ttfautohint.git/blob_plain/HEAD:/INSTALL.git)
22 (part of the source code bundle) for generic instructions how to compile the
23 ttfautohint library together with its front-ends using a POSIX compatible
24 shell and compiler.
26 Unix-like Platforms
27 -------------------
29 The generic instructions should work just fine.  Since ttfautohint depends
30 on [Qt] version 4.x.x, [FreeType] version 2.4.5 or newer, and [HarfBuzz]
31 version 0.9.19 or newer, you should install packages for these libraries
32 (called 'libqt4', 'libfreetype6'^[The number\ '6' indicates the version of
33 the shared library of FreeType, which is not directly related to the source
34 code version of FreeType.], and 'libharfbuzz0' or similar) together with its
35 development bundles (called 'libqt4-devel', 'freetype2-devel', and
36 'harfbuzz-devel' or similar) before running ttfautohint's `configure`
37 script.
40 MS Windows
41 ----------
43 Precompiled binaries `ttfautohint.exe` and `ttfautohintGUI.exe` are
44 available, being statically linked to [Qt], [FreeType], and [HarfBuzz].
45 This means that the two programs are not dependent on any other
46 program-specific DLL, and you can move them to any place you like.
48 Hints for compilation with the [MinGW] environment are given in
49 `INSTALL.git`.
52 Mac OS X
53 --------
55 Right now, only a precompiled binary `ttfautohint` is offered; a
56 ready-to-run app bundle for the GUI version is not yet available.
58 Detailed instructions to compile both `ttfautohint` and `ttfautohintGUI` can
59 be found on [ttfautohint's
60 homepage](http://freetype.org/ttfautohint/osx.html).
63 Authors
64 =======
66 Copyright © 2011-2014 by [Werner Lemberg](mailto:wl@gnu.org).\
67 Copyright © 2011-2014 by [Dave Crossland](mailto:dave@understandingfonts.com).
69 This file is part of the ttfautohint library, and may only be used,
70 modified, and distributed under the terms given in
71 [`COPYING`](http://repo.or.cz/w/ttfautohint.git/blob_plain/HEAD:/COPYING).
72 By continuing to use, modify, or distribute this file you indicate that you
73 have read `COPYING` and understand and accept it fully.
75 The file `COPYING` mentioned in the previous paragraph is distributed with
76 the ttfautohint library.
79 [Dalton Maag Ltd]: http://daltonmaag.com
80 [DejaVu]: http://dejavu-fonts.org
81 [FontForge]: http://fontforge.sf.net
82 [FreeType]: http://freetype.org
83 [HarfBuzz]: http://harfbuzz.org
84 [Infinality]: http://infinality.net
85 [MinGW]: http://mingw.org
86 [OpenType specification]: http://www.microsoft.com/typography/otspec
87 [Qt]: http://qt-project.org
88 [Vernon Adams]: http://code.newtypography.co.uk
91 History
92 =======