Skip to main content

add a basic spec

ID
7901c5e
date
2024-08-19 13:31:14+00:00
author
Alex Chan <alex@alexwlchan.net>
parent
1cf7083
message
add a basic spec
changed files
1 file, 34 additions

Changed files

README.md (74) → README.md (720)

diff --git a/README.md b/README.md
index 202b661..ad49124 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,35 @@
 create-thumbnail PATH [--width=WIDTH | --height=HEIGHT] --out-dir=OUT_DIR
+
+focusing on a small piece of code makes it better
+
+* pull out dimension choosing
+    -> test that code
+        image which is smaller in width/height
+        rounding errors?
+
+* CLI:
+    -> version
+    -> help
+    -> width + height
+    -> neither of width/height
+    -> width only
+    -> height only
+
+* happy path:
+    -> animated GIF
+    -> static GIF
+    -> PNG
+    -> JPEG
+    -> TIF
+    -> small file
+
+* errors:
+    -> creates thumbnail directory
+    -> /dev/null
+    -> thumbnail dir is file?
+    -> try to overwrite original file?
+    -> non-image format
+    -> unrecognised image format
+    -> non-existent file
+
+* print name of thumbnail
\ No newline at end of file