From d25317f67f3c5c77f9059961935b0f35cbaa9ac4 Mon Sep 17 00:00:00 2001 From: Khaled Hosny Date: Wed, 23 Dec 2015 01:29:48 +0400 Subject: [PATCH] Move more docs from FreeDesktop page --- docs/Makefile.am | 1 + docs/harfbuzz-docs.xml | 15 ++++---- docs/usermanual-install-harfbuzz.xml | 70 ++++++++++++++++++++++++++++++++++++ 3 files changed, 80 insertions(+), 6 deletions(-) create mode 100644 docs/usermanual-install-harfbuzz.xml diff --git a/docs/Makefile.am b/docs/Makefile.am index 05a27db..5e6fd2b 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -75,6 +75,7 @@ content_files= \ usermanual-fonts-and-faces.xml \ usermanual-glyph-information.xml \ usermanual-hello-harfbuzz.xml \ + usermanual-install-harfbuzz.xml \ usermanual-opentype-features.xml \ usermanual-what-is-harfbuzz.xml \ version.xml diff --git a/docs/harfbuzz-docs.xml b/docs/harfbuzz-docs.xml index 49252f7..7d2232f 100644 --- a/docs/harfbuzz-docs.xml +++ b/docs/harfbuzz-docs.xml @@ -7,11 +7,6 @@ HarfBuzz Manual - - This document is for HarfBuzz &version;. - - HarfBuzz @@ -28,7 +23,7 @@ here. Also available on github. - See below for release tarballs. + See for release tarballs. The old HarfBuzz codebase, these days known as harfbuzz-old, was @@ -46,6 +41,7 @@ User's manual + @@ -54,6 +50,13 @@ + + + This document is for HarfBuzz &version;. + + + Reference manual Harfbuzz API diff --git a/docs/usermanual-install-harfbuzz.xml b/docs/usermanual-install-harfbuzz.xml new file mode 100644 index 0000000..be8ac8d --- /dev/null +++ b/docs/usermanual-install-harfbuzz.xml @@ -0,0 +1,70 @@ + + Install Harfbuzz +
+ Download + + For tarball releases of HarfBuzz, look + here. + At the same place you will + also find Win32 binary bundles that include libharfbuzz DLL, hb-view.exe, + hb-shape.exe, and all dependencies. + + + The canonical source tree is available + here. + Also 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, will 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 + this. + +
+
+ Building + + On Linux, install the development packages for FreeType, Cairo, and GLib. + For example, on Ubuntu / Debian, you would do: + +sudo apt-get install gcc g++ libfreetype6-dev libglib2.0-dev libcairo2-dev + + whereas on Fedora, RHEL, CentOS, and other Red Hat based systems you would do: + +sudo yum install gcc gcc-c++ freetype-devel glib2-devel cairo-devel + + or using MacPorts: + +sudo port install freetype glib2 cairo + + + + If you are using a tarball, you can now proceed to running + configure and make as with any + other standard package. That should leave you with a shared library in + src/, and a few utility programs including hb-view + and hb-shape under util/. + + + If you are bootstraping from git, you need a few more tools before you + can run autogen.sh for the first time. Namely, + pkg-config and ragel. + Again, on Ubuntu / Debian: + +sudo apt-get install autoconf automake libtool pkg-config ragel gtk-doc-tools + + and on Fedora, RHEL, CentOS: + +sudo yum install autoconf automake libtool pkgconfig ragel gtk-doc + + or using MacPorts: + +sudo port install autoconf automake libtool pkgconfig ragel gtk-doc + + +
+ -- 2.7.4