From f4b77d7dc61b5676b184066f4778482f31731d42 Mon Sep 17 00:00:00 2001 From: atomofiron Date: Thu, 27 Jul 2023 02:28:59 +0400 Subject: [PATCH] update functionality info in readme --- README.md | 42 ++++++++++++++++++++++++++---------------- 1 file changed, 26 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 334ebc3..27422e4 100644 --- a/README.md +++ b/README.md @@ -11,14 +11,14 @@ https://github.com/Atomofiron/img2fbm/assets/14147217/59cbb785-d17d-46e0-a8fe-b8 ``` Flipper bitmap files generator -Usage: img2fbm [OPTIONS] [DOLPHIN] +Usage: img2fbm [OPTIONS] [dolphin] Arguments: - + Path to png|jpg|jpeg|gif file - [DOLPHIN] - Target path to the 'dolphin' directory, if the gif passed + [dolphin] + Path to the 'dolphin' directory, if the gif passed Options: -H, --height <1-64> @@ -28,13 +28,23 @@ Options: --st Scale type + + [default: fit] Possible values: - - fill-center: Scale to fill animation bounds - - fit-center: Scale to fit in animation bounds - - fit-bottom: Scale to fit in animation bounds and align bottom + - fill: Scale to fill animation bounds + - fit: Scale to fit in animation bounds + + -a, --alignment + Applied alignment if the source picture has aspect ratio different from the target + + [default: bottom] - [default: fit-bottom] + Possible values: + - left: Align source picture to left + - top: Align source picture to top + - right: Align source picture to right + - bottom: Align source picture to bottom -p, --preview Generate the previews of result pictures @@ -42,7 +52,7 @@ Options: --op Only preview, do not generate .bm and other Flipper Animation files - --ps + --ps Preview scale ratio [default: 3] @@ -55,18 +65,18 @@ Options: -b, --background Set background pixels visible + + [default: invisible] Possible values: - invisible: Keep transparent, white, unset, zero - - left: Make visible on the right side - - right: Make visible on the left side + - start: Make visible on the left or top side + - end: Make visible on the right or bottom side - visible: Make visible, black, set, unit - [default: invisible] - -t, --threshold Threshold value or range of pixel brightness as a percentage, such as 20:80, 40:, :60, 50:50 or 50 - + [default: 20:80] -s, --speed @@ -75,8 +85,8 @@ Options: [default: 1] -c, --cut - Drop some frames from the start and from the end. For example 5:, :8 or 2:3, the last one drops 2 frames from start and 3 from the end. - + Drop some frames from the start and from the end. For example 5:, :8 or 2:3, the last one drops 2 frames from start and 3 from the end + [default: 0:0] ```