8000 docs: tidy readme by helgibbons · Pull Request #10 · pimoroni/inky-frame · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: tidy readme #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 34 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,28 @@
# Inky Frame
# Inky Frame<!-- omit in toc -->

## Pico W and Pico 2 W powered ePaper display boards<!-- omit in toc -->

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

- [Get Inky Frame](#get-inky-frame)
- [Download Firmware](#download-firmware)
- [Installation](#installation)
- [Useful Links](#useful-links)
- [Other Resources](#other-resources)

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

## 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)

## Download Firmware

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

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))
Expand All @@ -15,15 +31,23 @@ 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).
## Installation

## Guides & Documentation
1. Connect Inky Frame to your computer with a micro USB cable.
2. Put your device into bootloader mode by holding down the BOOTSEL button (on the Pico W / Pico 2 W) whilst tapping Reset (on the Inky Frame board).
3. Drag and drop the downloaded .uf2 file to the "RPI-RP2" or "RP2350" drive that appears.
4. Your device should reset, and you should then be able to connect to it using [Thonny](https://thonny.org/).
5. These builds are pre-configured for Inky Frame 7.3". If you have a different size of Inky Frame you'll need to edit `main.py` with Thonny and uncomment the line with the correct display size.

* [Getting Started With Inky Frame](https://learn.pimoroni.com/article/getting-started-with-inky-frame)
* [inky_frame Module Reference](docs/inky_frame.md)
## Useful Links

## Get Inky Frame
- [Learn: Getting Started With Inky Frame](https://learn.pimoroni.com/article/getting-started-with-inky-frame)
- [`inky_frame` Function Reference](docs/inky_frame.md)
- [Pico Graphics Function Reference](https://github.com/pimoroni/pimoroni-pico/blob/main/micropython/modules/picographics/README.md)

## Other Resources

Links to community projects and other resources that you might find helpful can be found below. Note that these code examples have not been written/tested by us and we're not able to offer support with them.

* [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)
- [Stay on schedule with Raspberry Pi Pico W and an e-ink dashboard](https://www.raspberrypi.com/news/stay-on-schedule-with-raspberry-pi-pico-w-and-an-e-ink-dashboard/)
- [Inky Frame displaying a Home Assistant dashboard with a Nextcloud Calendar](https://blog.paco.to/2023/inky-frame-lovelace-dashboard-nextcloud/)
Loading
0