graphlcd-base/docs/README.crtfont
changeset 4 df6a40031aa5
equal deleted inserted replaced
3:d0e62fc47285 4:df6a40031aa5
       
     1 This is the README of the crtfont tool, which is part of the GraphLCD
       
     2 base package.
       
     3 
       
     4 written by Andreas Regel (andreas.regel AT powarman.de)
       
     5 
       
     6 based on crtfont from the graphlcd plugin for the Video Disc Recorder
       
     7 written by Carsten Siebholz (c.siebholz AT t-online.de)
       
     8 
       
     9 See the file COPYING for license information.
       
    10 
       
    11 
       
    12 Description:
       
    13 ------------
       
    14 crtfont is a program to create fonts for the GraphLCD graphics library.
       
    15 
       
    16 
       
    17 Installation and Configuration:
       
    18 -------------------------------
       
    19 see the file README in the base package's root directory.
       
    20 
       
    21 
       
    22 Using crtfont:
       
    23 --------------
       
    24 To create a font, 2 source files are required:
       
    25 - an image, that contains the characters as a bitmap. This image might
       
    26   be in:
       
    27   - Portable Bit Map (PBM) format.
       
    28 - a description file (*.desc), that contains informations about the
       
    29   positions of each character in the image.
       
    30   The format of the description file:
       
    31   - The first line contains the version of the description file format:
       
    32       version:1
       
    33   - The next lines contain the font attributes in the format
       
    34     <attribute>:<value>, one attribute per line. Possible attributes
       
    35 	are:
       
    36       fontheight: the total height of the font
       
    37       fontascent: the vertical distance from the horizontal baseline to
       
    38                   the highest character coordinate.
       
    39       lineheight: the baseline-to-baseline distance
       
    40       spacebetween: additional space between characters in a text
       
    41       spacewidth: the width of the space character. If this value is
       
    42                   greater than zero, all characters will be compressed
       
    43                   horizontally to their active pixels.
       
    44   - All other lines define the characters and their positions in the
       
    45     image. The syntax is like:
       
    46       PosX_1 Char_1 PosX_2 Char_2 PosX_3  ... PosX_n Char_n EndX
       
    47     where PosX_x specifies the horizontal position of the leftmost
       
    48     pixel of the character. Char_x might be the character itself
       
    49     (A, B, ...) or it's decimal ASCII value (65, 66, ...)
       
    50 
       
    51 Usage: crtfont -f <format> -b <bmpfile> -d <descfile> -o <outfile>
       
    52 
       
    53   -f  --format    specifies the format of the bitmap. Possible values
       
    54                   are:
       
    55                     PBM: file is an Portable Bit Map
       
    56   -b  --bmpfile   specifies the name of the bitmap file (*.pbm)
       
    57   -d  --descfile  specifies the name of the description file (*.desc)
       
    58   -o  --outfile   specifies the name of the output file (*.fnt)
       
    59 
       
    60   example: crtfont -f PBM -b f12.pbm -d f12.desc -o f12.fnt
       
    61