Update documentation

pull/31/head
Timothy Lovelock 2021-01-23 21:28:42 +01:00
rodzic 391c7c80d9
commit 6f92a32848
2 zmienionych plików z 6 dodań i 5 usunięć

Wyświetl plik

@ -45,8 +45,8 @@ installed using `pip3`. On Linux (you may need a root prompt):
# Usage # Usage
`font_to_py.py` is a command line utility written in Python 3. It is run on a `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 PC. It takes as input a font file with a `ttf`, `otf`, or `bdf` extension and a
required height in pixels and outputs a Python 3 source file. The pixel layout 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 is determined by command arguments. By default fonts are stored in variable
pitch form. This may be overidden by a command line argument. 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: ### Mandatory positional arguments:
1. Font file path. Must be a ttf or otf file. 1. Font file path. Must be a ttf, otf, or bdf file.
2. Height in pixels. 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 3. Output file path. Filename must have a .py extension (unless writing a
binary font). binary font).

Wyświetl plik

@ -44,7 +44,8 @@ This comprises three components, links to docs below:
# font_to_py.py # font_to_py.py
This command line utility is written in Python 3 and runs on a PC. It takes 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 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: variable pitch rendering are supported. The design has the following aims: