From bbd30de8a8a369bfa7db10eed312f1ca7d204f5a Mon Sep 17 00:00:00 2001 From: Akiroz Date: Sun, 1 Mar 2020 14:29:03 +0800 Subject: [PATCH] Update README.md --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9a5bfb0..7862c5a 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,11 @@ Download the bundled `monofont.html` from the [releases](https://github.com/akir and open locally in Chrome or Firefox. ![](screenshot.png) + +After rendering, 2 files are generated: + +- `font.index.bin`: (Int32Array) Index for mapping Unicode code-points to offsets in the data file. + A value of `-1` indicates the char data for that code-point does not exist in the data file. + Byte width of each character is simply width (px) * height (bytes). +- `font.data.bin`: (UInt8Array) Bitmap image data for each character in LCD/OLED byte order. + (Ref: https://learn.sparkfun.com/tutorials/microview-hookup-guide/oled-memory-map)