diff --git a/README.md b/README.md new file mode 100644 index 0000000..9b4a6ba --- /dev/null +++ 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. \ No newline at end of file