From c3fb70de31902aedfa93a0ff0801d24bd9904ac7 Mon Sep 17 00:00:00 2001 From: sloumdrone Date: Sun, 2 Jun 2019 22:02:24 -0700 Subject: [PATCH] ADded readme --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index e69de29..b7e57ae 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,23 @@ +# Lid +_lo-fi image dithering_ + +Lid performs fairly basic 1 bit image dithering. It converts an input image to grayscale and then dithers that image. It then optimizes the output and saves the file. The result is a reduced filesize, simple image, great for small apge sizes. + +## Dependencies + +- Python3.x (built and tested with 3.6) +- PIL (python3 -m pip install Pillow) + +## Documentation + +lid [option]... [source path] [output name] + +Options: +-f = output format, defaults to the recommended setting: png +-q = quality, defaults to 90, only affects png & jpeg/jpg + +source path = a path to an image file you want to dither +output name = the name of the file you would like to output, do not include file extension + +## License +Public domain. Use it, improve it, share it!