9622337b52
Copied from: https://web.archive.org/web/20191221151847/https://freedesktop.org/wiki/Software/HarfBuzz/ Edited lightly trying to merge it with existing README.md content and remove grossly outdated bits. Might still need more editing. Fixes https://github.com/harfbuzz/harfbuzz/issues/1919 |
||
---|---|---|
.ci | ||
.circleci | ||
.github/workflows | ||
docs | ||
m4 | ||
perf | ||
src | ||
subprojects | ||
test | ||
util | ||
.clang-format | ||
.codecov.yml | ||
.editorconfig | ||
AUTHORS | ||
BUILD.md | ||
CMakeLists.txt | ||
CONFIG.md | ||
COPYING | ||
Makefile.am | ||
NEWS | ||
README | ||
README.md | ||
README.mingw.md | ||
README.python.md | ||
RELEASING.md | ||
TESTING.md | ||
THANKS | ||
autogen.sh | ||
configure.ac | ||
git.mk | ||
harfbuzz.doap | ||
meson.build | ||
meson_options.txt | ||
mingw-configure.sh | ||
replace-enum-strings.cmake |
README.md
HarfBuzz
HarfBuzz is a text shaping engine. It primarily supports OpenType, but also Apple Advanced Typography. HarfBuzz is used in Android, Chrome, ChromeOS, Firefox, GNOME, GTK+, KDE, LibreOffice, OpenJDK, PlayStation, Qt, XeTeX, and other places.
For bug reports, mailing list, and other information please visit:
For license information, see COPYING.
Documentation
For user manual as well as API documentation, check: https://harfbuzz.github.io
Download
For tarball releases of HarfBuzz, look here. At the same place you will also find Win32/Win64 binary bundles that include libharfbuzz DLL, hb-view.exe, hb-shape.exe, and all dependencies.
The canonical source tree is available on github.
The API that comes with hb.h
will not change incompatibly. Other, peripheral,
headers are more likely to go through minor modifications, but again, we do our
best to never change API in an incompatible way. We will never break the ABI.
If you are not sure whether Pango or HarfBuzz is right for you, read Pango vs HarfBuzz.
Development
For build information, see BUILD.md.
For custom configurations, see CONFIG.md.
For test execution, see TESTING.md.
To get a better idea of where HarfBuzz stands in the text rendering stack you may want to read State of Text Rendering, though, that document is many years old. Here are a few presentation slides about HarfBuzz at the Internationalization and Unicode Conference over the years:
- November 2014, Unicode, OpenType, and HarfBuzz: Closing the Circle,
- October 2012, HarfBuzz, The Free and Open Text Shaping Engine,
- October 2009, HarfBuzz: the Free and Open Shaping Engine.
Both development and user support discussion around HarfBuzz happens on the github.
To report bugs or submit patches please use github issues and pull-requests.
For a comparison of old vs new HarfBuzz memory consumption see this.