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