Merge pull request #76 from litlnemo/readmefixes

Updates to readme
rbaron · Aug 27, 2024 · a5e00c8 · a5e00c8
2 parents f99c610 + 9206f11
commit a5e00c8
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -29,10 +29,10 @@ prints an image on your cat thermal printer
 positional arguments:
   filename
 
-optional arguments:
+options:
   -h, --help            show this help message and exit
   -l {debug,info,warn,error}, --log-level {debug,info,warn,error}
-  -b {mean-threshold,floyd-steinberg,halftone,none}, --img-binarization-algo {mean-threshold,floyd-steinberg,halftone,none}
+  -b {mean-threshold,floyd-steinberg,atkinson,halftone,none}, --img-binarization-algo {mean-threshold,floyd-steinberg,atkinson,halftone,none}
                         Which image binarization algorithm to use. If 'none'
                         is used, no binarization will be used. In this case
                         the image has to have a width of 384 px.
@@ -68,11 +68,23 @@ optional arguments:
 
 # Different Algorithms
 
-Mean Threshold:
-![Mean threshold](./media/grumpy_mean_threshold.png)
+**Mean Threshold:**
 
-Floyd Steinberg (default)
-![Floyd Steinberg](./media/grumpy_floydsteinberg.png)
+![Mean threshold](./media/grumpymeanthreshold.png)
 
-Halftone dithering
-![Halftone](./media/grumpy_halftone.png)
+
+**Floyd Steinberg (default):**
+
+![Floyd Steinberg](./media/grumpyfloydsteinbergexample.png)
+
+**Atkinson:**
+
+![Atkinson](./media/grumpyatkinsonexample.png)
+
+**Halftone dithering:**
+
+![Halftone](./media/grumpyhalftone.png)
+
+**None (image must be 384px wide):**
+
+![None](./media/grumpynone.png)
diff --git a/media/grumpy_floydsteinberg.png b/media/grumpy_floydsteinberg.png
diff --git a/media/grumpy_halftone.png b/media/grumpy_halftone.png
diff --git a/media/grumpy_mean_threshold.png b/media/grumpy_mean_threshold.png
diff --git a/media/grumpyatkinsonexample.png b/media/grumpyatkinsonexample.png
diff --git a/media/grumpyfloydsteinbergexample.png b/media/grumpyfloydsteinbergexample.png
diff --git a/media/grumpyhalftone.png b/media/grumpyhalftone.png
diff --git a/media/grumpymeanthreshold.png b/media/grumpymeanthreshold.png
diff --git a/media/grumpynone.png b/media/grumpynone.png