Include kerning information in definition file

[ttf2png.git] / Readme

diff --git a/Readme b/Readme
index b8abf114e3ad83d4b8ac4110057b45a764ddc5e3..36728d7d2fcc2c25097da4c4ac9958feaa3d1e72 100644 (file)
--- a/Readme
+++ b/Readme
@@ -70,17 +70,17 @@ information, called font metrics.  To that end, ttf2png can write a definition
 file alongside the image.
 
 The basic format is line-based.  Empty lines, or those starting with a hash
 file alongside the image.
 
 The basic format is line-based.  Empty lines, or those starting with a hash

-sign (#), should be ignored.  Data lines consist of fields separated with
-spaces.
+sign (#), should be ignored.  Data lines consist of a keyword followed by
+space-separated fields.

 
 

-The first data line contains five fields with overall information about the
-image and the font:
+The keyword "font" is followed by five fields with overall information about
+the image and the font:

 
   Fields 1-2: width and height of the image
   Field 3: nominal size of the font
   Fields 4-5: ascent and descent of the font
 
 
   Fields 1-2: width and height of the image
   Field 3: nominal size of the font
   Fields 4-5: ascent and descent of the font
 

-Subsequent data lines each describe a single glyph and contain eight fields:
+The keyword "glyph" is followed by eight fields describing a single glyph:

 
   Field 1: the code point of the glyph
   Fields 2-3: x and y position of the glyph in the image
 
   Field 1: the code point of the glyph
   Fields 2-3: x and y position of the glyph in the image


@@ -88,6 +88,13 @@ Subsequent data lines each describe a single glyph and contain eight fields:
   Fields 6-7: x and y offset of the glyph from its base point
   Field 8: advance from this glyph to the next
 
   Fields 6-7: x and y offset of the glyph from its base point
   Field 8: advance from this glyph to the next
 

+The keyword "kern" is followed by three fields describing kerning between two
+glyphs:
+
+  Field 1: the code point of the left-hand glyph
+  Field 2: the code point of the right-hand glyph
+  Field 3: kerning distance between the glyphs
+

 The following ASCII art image illustrates most of these metrics.  Note that in
 some fonts, not all of the glyphs fit completely inside the character box.
 
 The following ASCII art image illustrates most of these metrics.  Note that in
 some fonts, not all of the glyphs fit completely inside the character box.
 


@@ -120,6 +127,7 @@ next
 - Improve the packing algorithm
 - Non-square cells for grid mode
 - Option to invert colors
 - Improve the packing algorithm
 - Non-square cells for grid mode
 - Option to invert colors

+- Include kerning information in definition file

 
 0.3
 - Restructure the code
 
 0.3
 - Restructure the code