Skip to content

Commit

Permalink
Add basic README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Gadgetoid committed Dec 3, 2024
1 parent 6961183 commit 4815aed
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Inky Frame

This repository is home to the MicroPython firmware and examples for
Inky Frame - a range of Pico-powered ePaper display boards.

![Three sizes of Inky Frame displayed side-to-side.](inky-frame.png)

## Download Firmware

There are two choices, a regular build that just updates the firmware on
your board and a "-with-examples" build which includes a ready-to-go set
of examples (everything in [examples/inkylauncher](examples/inkylauncher))
that you can interact with right on your display.

:warning: If you've changed any of the code on your board then back up before
flashing "-with-examples" - *your files will be erased!*

You can find the latest release at [https://github.com/pimoroni/inky-frame/releases/latest](https://github.com/pimoroni/inky-frame/releases/latest).

## Get Inky Frame

* [Inky Frame 7.3"](https://shop.pimoroni.com/products/inky-frame-7-3?variant=40541882056787)
* [Inky Frame 5.7"](https://shop.pimoroni.com/products/inky-frame-5-7?variant=40057850331219)
* [Inky Frame 4.0"](https://shop.pimoroni.com/products/inky-frame-4?variant=40443825127507)
Binary file added inky-frame.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4815aed

Please sign in to comment.