aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJuan J. Martinez <jjm@usebox.net>2024-07-14 15:13:56 +0100
committerJuan J. Martinez <jjm@usebox.net>2024-07-14 15:13:56 +0100
commit380ff37feadd00a6b96d85e671709851d894e12f (patch)
tree2e1c4c922719d10b53f9a9c980c0560956da71c9 /README.md
downloadsspreview-380ff37feadd00a6b96d85e671709851d894e12f.tar.gz
sspreview-380ff37feadd00a6b96d85e671709851d894e12f.zip
Initial import
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9640753
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# SpriteSheet Animation Preview
+
+Requires:
+
+* Python 3
+* tinker
+* PIL (with TkImage)
+
+In Debian:
+
+```
+sudo apt install python3-tk python3-pil python3-pil.imagetk
+```
+
+Use it with:
+
+```
+sspreview spritesheet.png
+```
+
+<img src="https://git.usebox.net/sspreview/plain/example.png" alt="Example" style="width:auto;">
+
+Caveats:
+
+* my first tinker app
+* wrrors (like invalid input) will terminate the app with a message in `stderr`
+* when parameters are changed, please `Update` for them to take effect
+
+This code is GPL licensed, see for details [gpl-3.0.txt](gpl-3.0.txt).
+