summaryrefslogtreecommitdiffstats
path: root/graphics/ttfautohint/README
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/ttfautohint/README')
-rw-r--r--graphics/ttfautohint/README36
1 files changed, 36 insertions, 0 deletions
diff --git a/graphics/ttfautohint/README b/graphics/ttfautohint/README
new file mode 100644
index 0000000000..842f87edff
--- /dev/null
+++ b/graphics/ttfautohint/README
@@ -0,0 +1,36 @@
+ttfautohint provides 99% automated hinting process and a
+platform for finely hand-hinting the last 1%. It is ideal
+for web fonts and supports many scripts: Latin,Greek,Hebrew,
+Devanagari,Khmer,Thai and many more.
+
+It takes a TrueType font as the input,removes its bytecode
+instructions (if any), and returns a new font where all
+glyphs are bytecode hinted using the information given by
+FreeType's auto-hinting module. The idea is to provide the
+excellent quality of the auto-hinter on platforms
+that don't use FreeType.
+
+The library has a single API function, `TTF_autohint'; see
+`lib/ttfautohint.h' for a detailed description.
+Note that the library itself won't get installed currently.
+
+A command-line interface to the library is the `ttfautohint'
+program; after compilation and installation, say
+
+ ttfautohint --help
+
+for usage information, or say
+
+ man ttfautohint
+
+Optional dependencies:
+
+Inkscape: To convert SVG images to PDF.
+pandoc-bin: To create pdf and html docs.
+
+Note:
+
+For this to build properly you will need to have a true login
+shell in order to have a correctly populated environment
+you will need to either use "su -l" when switching to root,
+or source the /etc/profile script after doing "su"