diff --git a/docs/HarfBuzz.png b/docs/HarfBuzz.png new file mode 100644 index 000000000..d58d9fc5a Binary files /dev/null and b/docs/HarfBuzz.png differ diff --git a/docs/Makefile.am b/docs/Makefile.am index f605f24b4..64344b851 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -65,7 +65,8 @@ EXTRA_HFILES=$(top_builddir)/src/hb-version.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png -HTML_IMAGES= +HTML_IMAGES= \ + HarfBuzz.png # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). # e.g. content_files=running.sgml building.sgml changes-2.0.sgml diff --git a/docs/harfbuzz-docs.xml b/docs/harfbuzz-docs.xml index 60ff8e28d..a7efbf848 100644 --- a/docs/harfbuzz-docs.xml +++ b/docs/harfbuzz-docs.xml @@ -8,10 +8,39 @@ HarfBuzz Manual - for HarfBuzz &version;. + This document is for HarfBuzz &version;. + + HarfBuzz + + + HarfBuzz is an OpenType + text shaping engine. + + + The current HarfBuzz codebase, formerly known as harfbuzz-ng, is + versioned 1.x.x and is stable and under active maintenance. This is + what is used in latest versions of Firefox, GNOME, ChromeOS, Chrome, + LibreOffice, XeTeX, Android, and KDE, among other places. The canonical + source tree is available + here. + Also available on + github. + See below for release tarballs. + + + The old HarfBuzz codebase, these days known as harfbuzz-old, was + derived from FreeType, + Pango, and + Qt and is available + here. + It is not actively developed or maintained, and is extremely buggy. All + users are encouraged to switch over to the new HarfBuzz as soon as + possible. There are no release tarballs of old HarfBuzz whatsoever. + +