Update README.md

akiroz · Mar 1, 2020 · bbd30de · bbd30de
1 parent 7e22bed
commit bbd30de
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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)