Intro from freedesktop.org/wiki/Software/HarfBuzz/
authorKhaled Hosny <khaledhosny@eglug.org>
Tue, 22 Dec 2015 20:26:20 +0000 (00:26 +0400)
committerKhaled Hosny <khaledhosny@eglug.org>
Wed, 23 Dec 2015 21:52:17 +0000 (01:52 +0400)
docs/HarfBuzz.png [new file with mode: 0644]
docs/Makefile.am
docs/harfbuzz-docs.xml

diff --git a/docs/HarfBuzz.png b/docs/HarfBuzz.png
new file mode 100644 (file)
index 0000000..d58d9fc
Binary files /dev/null and b/docs/HarfBuzz.png differ
index f605f24..64344b8 100644 (file)
@@ -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
index 60ff8e2..a7efbf8 100644 (file)
@@ -8,10 +8,39 @@
   <bookinfo>
     <title>HarfBuzz Manual</title>
     <releaseinfo>
-      for HarfBuzz &version;.
+      This document is for HarfBuzz &version;.
       <!--The latest version of this documentation can be found on-line at
       <ulink role="online-location" url="http://[SERVER]/libharfbuzz/index.html">http://[SERVER]/libharfbuzz/</ulink>.-->
     </releaseinfo>
+    <abstract>
+      <title>HarfBuzz</title>
+      <graphic fileref="HarfBuzz.png" format="PNG" align="center"/>
+      <para>
+        HarfBuzz is an <ulink url="http://www.microsoft.com/typography/otspec/">OpenType</ulink>
+        text shaping engine.
+      </para>
+      <para>
+        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
+        <ulink url="http://cgit.freedesktop.org/harfbuzz/">here</ulink>.
+        Also available on
+        <ulink url="https://github.com/behdad/harfbuzz">github</ulink>.
+        See below for release tarballs.
+      </para>
+      <para>
+        The old HarfBuzz codebase, these days known as harfbuzz-old, was
+        derived from <ulink url="http://freetype.org/">FreeType</ulink>,
+        <ulink url="http://pango.org/">Pango</ulink>, and
+        <ulink url="http://qt-project.org/">Qt</ulink> and is available
+        <ulink url="http://cgit.freedesktop.org/harfbuzz.old/">here</ulink>.
+        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.
+      </para>
+    </abstract>
   </bookinfo>
 
   <part>