diff --git a/FONT_TO_PY.md b/FONT_TO_PY.md index 51682c3..c22a6c5 100644 --- a/FONT_TO_PY.md +++ b/FONT_TO_PY.md @@ -45,8 +45,8 @@ installed using `pip3`. On Linux (you may need a root prompt): # Usage `font_to_py.py` is a command line utility written in Python 3. It is run on a -PC. It takes as input a font file with a `ttf` or `otf` extension and a -required height in pixels and outputs a Python 3 source file. The pixel layout +PC. It takes as input a font file with a `ttf`, `otf`, or `bdf` extension and a +required height in pixels (for bitmap `bdf` fonts, height can be automatically determined) and outputs a Python 3 source file. The pixel layout is determined by command arguments. By default fonts are stored in variable pitch form. This may be overidden by a command line argument. @@ -69,8 +69,8 @@ $ font_to_py.py -k extended FreeSans.ttf 23 my_extended_font.py ### Mandatory positional arguments: - 1. Font file path. Must be a ttf or otf file. - 2. Height in pixels. + 1. Font file path. Must be a ttf, otf, or bdf file. + 2. Height in pixels. Specify `0` for bdf bitmap files to automatically use native height 3. Output file path. Filename must have a .py extension (unless writing a binary font). diff --git a/README.md b/README.md index defff6b..900e427 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,8 @@ This comprises three components, links to docs below: # font_to_py.py This command line utility is written in Python 3 and runs on a PC. It takes -as input a font file in `ttf` or `otf` form together with a height in pixels +as input a font file in `ttf`, `otf`, or `bdf` form together with a height in pixels +(for bitmap fonts in `bdf` format, the height can be automatically detected) and outputs a Python source file containing the font as a bitmap. Fixed and variable pitch rendering are supported. The design has the following aims: