From 50991c6de2a157db1075054fdf578fcf911feb00 Mon Sep 17 00:00:00 2001 From: uosfz Date: Thu, 31 Jul 2025 01:12:05 +0200 Subject: [PATCH] add README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6f3a9d7 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# Font Helper for Karlos + +## Features +- take images containing several chars and break them down into individual images + - images containing several consecutive characters in 2D arrangement + - images containing several arbitrary characters in 1D arrangement + - images containing a single character +- build a font automatically out of these individual images + - sequential chars are automatically grouped + +## Example +run `cargo run -- example/index.json`