aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatt Singleton <matt@xcolour.net>2024-02-04 13:15:37 -0600
committerMatt Singleton <matt@xcolour.net>2024-02-04 13:15:37 -0600
commitbc7d47c1911aff00c1dff49368b2f4ecb5fe4355 (patch)
tree3d3d5fa3235262e8cfc4de58dea216efb3090ad6 /README.md
parentbb06503bc6e5e27c4bda3bb4359ec82cfb3b5ed5 (diff)
markdown readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a836976
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+A collection of tools for interacting with the [epd7in3f](https://www.waveshare.com/product/displays/e-paper/7.3inch-e-paper-f.htm)
+7-color electrophoretic display sold by Waveshare.
+
+## `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.