From bc7d47c1911aff00c1dff49368b2f4ecb5fe4355 Mon Sep 17 00:00:00 2001 From: Matt Singleton Date: Sun, 4 Feb 2024 13:15:37 -0600 Subject: markdown readme --- README | 22 ---------------------- README.md | 20 ++++++++++++++++++++ 2 files changed, 20 insertions(+), 22 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 7581d0f..0000000 --- a/README +++ /dev/null @@ -1,22 +0,0 @@ -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. 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. -- cgit v1.2.3