Refactor image initialization

[ttf2png.git] / Readme

diff --git a/Readme b/Readme
index 111f53cadd2f63d418386aeedf350d4e8d3f7f89..c4fc9d05cbfb2ca7fd07a412ca1c2d6000291586 100644 (file)
--- a/Readme
+++ b/Readme
@@ -1,25 +1,28 @@
 ttf2png - True Type Font to PNG converter
-Copyright (c) 2004-2008  Mikko Rasa, Mikkosoft Productions
+Copyright (c) 2004-2018  Mikko Rasa, Mikkosoft Productions
 
 
 Software requirements
 
 FreeType 2
-libpng 1.2
+libpng 1.6
 C compiler (preferably GCC)
 
 
 Command-line options
 
   -r <low>,<high>
-    Range of characters to convert, specified as unicode code points.  The
-    default is 0,255, matching the ISO-8859-1 (Latin-1) character set.
+    Range of code points to convert, specified as unicode code points.  The
+    default is 0,255, matching the ISO-8859-1 (Latin-1) character set.  Code
+    points can be specified as plain numbers, unicode code points (U+xxxx) or
+    UTF-8 characters.  This option can be specified multiple times to add
+    more ranges to be converted.
 
   -s <pixels>
     Font size to use.  The default is 10 pixels.
 
   -l <num>
-    Number of characters to put in one line.  Defaults to autodetect.  Ignored
+    Number of glyphs to put in one line.  Defaults to autodetect.  Ignored
     if -p is used.
 
   -c <pixels>[x<pixels>]
@@ -42,7 +45,8 @@ Command-line options
 
   -i
     Invert colors of the glyphs.  When rendering to alpha channel, only the
-    alpha channel is inverted.
+    alpha channel is inverted.  The default is to render black glyphs on a
+    white background.
 
   -v
     Increase the level of verbosity.
@@ -52,10 +56,33 @@ Command-line options
     each glyph is determined by its code point.  Ignored if -p is used.
 
   -p
-    Pack the glyphs tightly in the image.  One-pixel gaps are left between
-    glyphs.  By default glyphs are rendered in a regular grid.  Creating a
-    definition file is recommended, as the resulting image can seem rather
-    messy.
+    Pack the glyphs tightly in the image.  Small gaps are left between glyphs,
+    controlled by the -n option.  By default glyphs are rendered in a regular
+    grid.  Creating a definition file is recommended, as the resulting image
+    can seem rather messy.
+
+  -m <pixels>
+    Leave a margin around the edges of the generated image.  By default glyphs
+    can touch the edges.  Only used with -p.
+
+  -n <pixels>
+    Control the amount of padding between glyphs.  The default is 1 pixel.
+    Only used with -p.
+
+  -g
+    Allow the resulting image to have a non-power-of-two size.  By default the
+    image size is rounded up to a power of two for maximum compatibility.
+
+  -f <num>
+    Generate a distance field texture.  The argument controls the amount of
+    oversampling when calculating distances.  Larger values may produce more
+    accurate results but take longer to process.  Distance fields are always
+    stored without alpha and with large/positive values indicating the inside
+    of glyphs; the -t and -i options are ignored.
+
+  -b <pixels>
+    Set the border zone width for distance field.  The default is the square
+    root of the font size.
 
   -d
     File name to write glyph definitions.  See the section below for details.
@@ -125,6 +152,16 @@ some fonts, not all of the glyphs fit completely inside the character box.
 Changelog
 
 next
+- Alternate ways of specifying code point ranges
+- Multiple code point ranges can be specified
+- Option to generate non-power-of-two images
+- Support for distance field generation
+
+1.1
+- Controllable margin and padding in packed mode
+- Do not generate overly large images in sequential grid mode
+
+1.0
 - Improve the packing algorithm
 - Non-square cells for grid mode
 - Option to invert colors