Update README.md

2021-02-11 22:56:54 -05:00 · 2021-02-11 22:56:54 -05:00 · 5efa561b20
parent bd8cca4cea
commit 5efa561b20
1 changed files with 16 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,16 @@
+reskit
+======
+
+***INCOMPLETE***
+
+Resource kit for the Sega Genesis/Megadrive.
+
+# Convert PNG to tile + palette set
+```
+reskit tileset --input file.png --output file.bin --format bin
+```
+The file format will contain the palette required by the image, followed by the image.
+
+## Caveats
+* Image dimensions that are not a multiple of 8 will be rounded up to the nearest multiple of 8.
+* Input images containing more than 15 colours will not be converted and will throw an error.