doc/ttfautohint-3.pandoc

   1 <!--
   2   Copyright (C) 2011-2022 by Werner Lemberg.
   3
   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.
   8
   9   The file `COPYING' mentioned in the previous paragraph is distributed
  10   with the ttfautohint library.
  11 -->
  12
  13
  14
  15 Compilation and Installation
  16 ============================
  17
  18 Please read the files
  19 [`INSTALL`](https://git.savannah.gnu.org/gitweb/?p=gnulib.git;a=blob_plain;f=doc/INSTALL;hb=HEAD)
  20 and
  21 [`INSTALL.git`](https://repo.or.cz/w/ttfautohint.git/blob_plain/HEAD:/INSTALL.git)
  22 (both part of the source code bundle) for instructions how to compile the
  23 ttfautohint library together with its front-ends using a POSIX compatible
  24 shell and compiler.
  25
  26
  27 Unix-like Platforms
  28 -------------------
  29
  30 The generic instructions should work just fine.  Since ttfautohint depends
  31 on [Qt] version\ 4 or newer, [FreeType] version 2.4.5 or newer, and
  32 [HarfBuzz] version 1.3.0 or newer, you should install packages for these
  33 libraries (called 'libqt4' or similar, 'libfreetype6'^[The number\ '6'
  34 indicates the version of the shared library of FreeType, which is not
  35 directly related to the source code version of FreeType.], and
  36 'libharfbuzz0' or similar) together with its development bundles (called
  37 'libqt4-devel', 'freetype2-devel', and 'harfbuzz-devel' or similar) before
  38 running ttfautohint's `configure` script.
  39
  40
  41 MS Windows
  42 ----------
  43
  44 Precompiled binaries `ttfautohint.exe` and `ttfautohintGUI.exe` are
  45 available, being statically linked to [Qt], [FreeType], and [HarfBuzz].
  46 This means that the two programs are not dependent on any other
  47 program-specific DLL, and you can move them to any place you like.
  48
  49 Hints for compilation with the [MinGW] environment are given in
  50 `INSTALL.git`.
  51
  52
  53 Mac OS X
  54 --------
  55
  56 Right now, only a precompiled binary `ttfautohint` is offered; a
  57 ready-to-run app bundle for the GUI version is not yet available; however,
  58 ttfautohint is part of [Homebrew](https://brew.sh), making compilation and
  59 installation very simple.
  60
  61 Detailed instructions to compile both `ttfautohint` and `ttfautohintGUI` can
  62 be found on [ttfautohint's
  63 homepage](https://freetype.org/ttfautohint/osx.html).
  64
  65
  66 Authors
  67 =======
  68
  69 Copyright © 2011-2022 by [Werner Lemberg](mailto:wl@gnu.org).\
  70 Portions Copyright © 2011-2017 by [Dave Crossland](mailto:dave@understandingfonts.com).\
  71 Portions Copyright © 2014 by [Adam Twardoch](mailto:adam@twardoch.com).
  72
  73 This file is part of the ttfautohint library, and may only be used,
  74 modified, and distributed under the terms given in
  75 [`COPYING`](https://repo.or.cz/w/ttfautohint.git/blob_plain/HEAD:/COPYING).
  76 By continuing to use, modify, or distribute this file you indicate that you
  77 have read `COPYING` and understand and accept it fully.
  78
  79 The file `COPYING` mentioned in the previous paragraph is distributed with
  80 the ttfautohint library.
  81
  82
  83 [ClearType Whitepaper]: https://learn.microsoft.com/en-us/typography/cleartype/truetypecleartype
  84 [Dalton Maag Ltd]: https://daltonmaag.com
  85 [DejaVu]: https://dejavu-fonts.github.io/
  86 [FontForge]: https://fontforge.github.io
  87 [FontLab Studio]: https://www.fontlab.com/font-editor/fontlab-studio
  88 [FreeType]: https://freetype.org
  89 [HarfBuzz]: http://harfbuzz.org
  90 [Infinality]: https://web.archive.org/web/20150710073951/http://www.infinality.net:80/blog/
  91 [MinGW]: http://mingw.org
  92 [OpenType specification]: https://learn.microsoft.com/en-us/typography/opentype/spec/
  93 [Qt]: https://qt.io
  94
  95
  96 Character Ranges
  97 ================
  98
  99 For the FreeType auto-hinter (and thus ttfautohint), a 'non-base character'
 100 is something that should not be affected by blue zones, regardless of
 101 whether this is a spacing or no-spacing glyph.
 102