gfx/harfbuzz/README.md

   1 [![Linux CI Status](https://github.com/harfbuzz/harfbuzz/workflows/linux-ci/badge.svg)](https://github.com/harfbuzz/harfbuzz/workflows/linux-ci/badge.svg)
   2 [![CircleCI Build Status](https://circleci.com/gh/harfbuzz/harfbuzz/tree/main.svg?style=svg)](https://circleci.com/gh/harfbuzz/harfbuzz/tree/main)
   3 [![OSS-Fuzz Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/harfbuzz.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html)
   4 [![Coverity Scan Build Status](https://scan.coverity.com/projects/15166/badge.svg)](https://scan.coverity.com/projects/harfbuzz)
   5 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/89c872f5ce1c42af802602bfcd15d90a)](https://www.codacy.com/gh/harfbuzz/harfbuzz/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=harfbuzz/harfbuzz&amp;utm_campaign=Badge_Grade)
   6 [![Codecov Code Coverage](https://codecov.io/gh/harfbuzz/harfbuzz/branch/main/graph/badge.svg)](https://codecov.io/gh/harfbuzz/harfbuzz)
   7 [![Packaging status](https://repology.org/badge/tiny-repos/harfbuzz.svg)](https://repology.org/project/harfbuzz/versions)
   8 [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/harfbuzz/harfbuzz/badge)](https://securityscorecards.dev/viewer/?uri=github.com/harfbuzz/harfbuzz)
   9
  10
  11 # HarfBuzz
  12
  13 HarfBuzz is a text shaping engine. It primarily supports [OpenType][1], but also
  14 [Apple Advanced Typography][2]. HarfBuzz is used in Android, Chrome,
  15 ChromeOS, Firefox, GNOME, GTK+, KDE, Qt, LibreOffice, OpenJDK, XeTeX,
  16 PlayStation, Microsoft Edge, Adobe Photoshop, Illustrator, InDesign,
  17 Godot Engine, and other places.
  18
  19 [![xkcd-derived image](xkcd.png)](https://xkcd.com/2347/)
  20
  21 For bug reports, mailing list, and other information please visit:
  22
  23   http://harfbuzz.org/
  24
  25 For license information, see [COPYING](COPYING).
  26
  27 ## Documentation
  28
  29 For user manual as well as API documentation, check: https://harfbuzz.github.io
  30
  31 ## Download
  32
  33 For tarball releases of HarfBuzz, look [here][3]. At the same place you
  34 will also find Win32/Win64 binary bundles that include `libharfbuzz` DLL,
  35 `hb-view.exe`, `hb-shape.exe`, and all dependencies.
  36
  37 The canonical source tree is available on [github][4].
  38
  39 The API that comes with `hb.h` will not change incompatibly. Other, peripheral,
  40 headers are more likely to go through minor modifications, but again, we do our
  41 best to never change API in an incompatible way. We will never break the ABI.
  42
  43 If you are not sure whether Pango or HarfBuzz is right for you, read [Pango vs
  44 HarfBuzz][5].
  45
  46 ## Development
  47
  48 For build information, see [BUILD.md](BUILD.md).
  49
  50 For custom configurations, see [CONFIG.md](CONFIG.md).
  51
  52 For testing and profiling, see [TESTING.md](TESTING.md).
  53
  54 To get a better idea of where HarfBuzz stands in the text rendering stack you
  55 may want to read [State of Text Rendering][6], though, that document is many
  56 years old. Here are a few presentation slides about HarfBuzz at the
  57 Internationalization and Unicode Conference over the years:
  58
  59 *   November 2014, [Unicode, OpenType, and HarfBuzz: Closing the Circle][7],
  60 *   October 2012, [HarfBuzz, The Free and Open Text Shaping Engine][8],
  61 *   October 2009, [HarfBuzz: the Free and Open Shaping Engine][9].
  62
  63 Both development and user support discussion around HarfBuzz happens on the
  64 [github][4].
  65
  66 To report bugs or submit patches please use [github][4] issues and
  67 pull-requests.
  68
  69 For a comparison of old vs new HarfBuzz memory consumption see [this][10].
  70
  71 <!--See past and upcoming [HarfBuzz Hackfests](https://freedesktop.org/wiki/Software/HarfBuzz/Hackfests/)!-->
  72
  73 ## Name
  74
  75 HarfBuzz (حرف‌باز) is my Persian translation of “[OpenType][1]”,
  76 transliterated using the Latin script. It sports a second meaning, but that
  77 ain’t translatable.
  78
  79 > Background: Originally there was this font format called TrueType. People and
  80 > companies started calling their type engines all things ending in Type:
  81 > FreeType, CoolType, ClearType, etc. And then came OpenType, which is the
  82 > successor of TrueType. So, for my OpenType implementation, I decided to stick
  83 > with the concept but use the Persian translation. Which is fitting given that
  84 > Persian is written in the Arabic script, and OpenType is an extension of
  85 > TrueType that adds support for complex script rendering, and HarfBuzz is an
  86 > implementation of OpenType complex text shaping.
  87
  88 <details>
  89   <summary>Packaging status of HarfBuzz</summary>
  90
  91 [![Packaging status](https://repology.org/badge/vertical-allrepos/harfbuzz.svg?header=harfbuzz)](https://repology.org/project/harfbuzz/versions)
  92
  93 </details>
  94
  95 [1]: https://docs.microsoft.com/en-us/typography/opentype/spec/
  96 [2]: https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6AATIntro.html
  97 [3]: https://github.com/harfbuzz/harfbuzz/releases
  98 [4]: https://github.com/harfbuzz/harfbuzz
  99 [5]: http://mces.blogspot.com/2009/11/pango-vs-harfbuzz.html
 100 [6]: http://behdad.org/text/
 101 [7]: https://goo.gl/FSIQuC
 102 [8]: https://goo.gl/2wSRu
 103 [9]: http://behdad.org/download/Presentations/slippy/harfbuzz_slides.pdf
 104 [10]: https://goo.gl/woyty