Update README.md

kresp0 · Dec 4, 2022 · 48cc023 · 48cc023
1 parent 17fd251
commit 48cc023
Showing 1 changed file with 21 additions and 42 deletions.
diff --git a/README.md b/README.md
@@ -11,52 +11,31 @@ A script to generate background images with text and text.png fonts for GB Studi
 * Customizable maximum height for the images
 * Automatically splits lines that are too long
 * Automatically splits images that are too long
+* Automatically tries to find the correct top padding and kerning
 
 ## Usage
 
-Usage: ./txt2gb.sh [options ...] input.txt
-
-Options: 
-
-Usage: 
-
-./txt2gb (0.2).sh [OPTIONS ...] input.txt
-
-./txt2gb (0.2).sh [OPTIONS ...] -g -f font
-
-Text settings: 
-
-    -f font         Font name to render text. Known working fonts are: ACM-VGA (default), CompaqThin, GBStudio-Stars (uppercase only) and Public-Pixel
-
-    -s px           Font Size: 8 (default, 19 char/line), 16 (9 char/line) and 32 (4 char/line)
-
-    -l lines        Leading (line spacing): 0 or 1 (default)
-
-    -p px           Padding to the left. Between 0 and 152. Usually a multiple of 8. Default: 8
-
-
-Advanced text settings:
-
-    -w char     Line Width in number of char: 1 to 20. It won't cut words. Defaults depending on size: 19, 9, 4
-
-    -t px           Padding to the Top of each line. Between 1 and 64. Defaults depending on size: 7, 15, 30
-
-    -i px           Interword spacing. Between -5 and 64. Default: 0
-
-    -k px           Kerning:  add or remove spacing between each letter. Between -5 and 5. Default: 0
-
-
-Image settings:
-
-    -c px           Maximum height for cutting the images. A multiple of 8 between 8 and 2040 (default)   
-
-    -a px           Image width. A multiple of 8 between 8 and 2040. Default: 160.
-
-
-GBS Font generation:
-
-    -g font         Generate a font.png to use in GBStudio from a font. A font name is required.
+        ./txt2gb.sh [OPTIONS ...] input.txt
+        ./txt2gb.sh [OPTIONS ...] -g -f font
 
+    Text settings: 
+        -f font         Font name to render text. Known working fonts are: ACM-VGA (default), CompaqThin, GBStudio-Stars (uppercase only) and Public-Pixel
+        -s px           Font Size: 8 (default, 19 char/line), 16 (9 char/line) and 32 (4 char/line)
+        -l lines        Leading (line spacing): 0 or 1 (default)
+        -p px           Padding to the left. Between 0 and 152. Usually a multiple of 8. Default: 8
+        -w char         Line Width in number of char: 1 to 20. It won't cut words. Defaults depending on size: 19, 9, 4
+
+    Advanced Font settings:
+        -t px           Padding to the Top of each line. Between 1 and 64. Defaults depending on size: 7, 15, 30
+        -i px           Interword spacing. Between -5 and 64. Default: 0
+        -k px           Kerning: add or remove spacing between each letter. Between -5 and 5. Default: 0
+
+    Image settings:
+        -c px           Maximum height for cutting the images. A multiple of 8 between 8 and 2040 (default)   
+        -a px           Image width. A multiple of 8 between 8 and 2040. Default: 160.
+
+    GBS Font generation:
+        -g            Generate a font.png to use in GBStudio from a font. Required: -f font.`
 
 
 ## Fonts for GB Studio