1 files changed, 22 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..7581d0f
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+convert_photo.py
+---
+cli tool for converting a photo in any format supported by pillow to a 7-color
+cropped, scaled, and dithered bmp suitable for sending to the frame
+
+epdify.py
+---
+library for converting images for display on the frame
+
+make_album_art.py
+---
+cli tool for converting album art to an image suitable for display on the frame
+
+mock_epd.py
+---
+dumb mock for the waveshare epd library so tooling can be developed without an
+spi interface present
+
+rotate.py
+---
+basic frame controller program that rotates through a collection of images.
+works best if images are already scaled, cropped, and dithered.