Skip to content

Commit

Permalink
Fix typos and omissions in README
Browse files Browse the repository at this point in the history
  • Loading branch information
samveen committed Apr 22, 2023
1 parent b2e2d04 commit c9ddd75
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# MicroPython Driver for the Waveshare Pico OLED 1.3

This is (hopefully) a better MicroPython driver for the [Waveshare Pico-Oled-1.3](https://www.waveshare.com/product/pico-oled-1.3.htm).
This is (hopefully) an improved MicroPython driver for the [Waveshare Pico-Oled-1.3](https://www.waveshare.com/product/pico-oled-1.3.htm) derived from the one provided by Waveshare.

<img src="example.gif" />

## Features

- Derived from the MicroPython Driver for the pico OLED 1.3 by Waveshare.
- initialization and access to the state of `key0` and `key1` via the display object.
- Initialization and access to the state of `key0` and `key1` via the display object.
- Better character display capabilities:
- Better variable width font than the build-in font provided by `framebuf`.
- Better fixed and variable width fonts than the build-in font provided by `framebuf`.
- Better `text` function:
- automatic wrapping of text
- Automatic wrapping of text.
- Returns endpoint coordinates of last written character.

## Usage

- Connect the display to the Raspberry Pi Pico W.
- Flash the Pico W with the latest [MicroPython](https://micropython.org/download/rp2-pico-w/).
- Copy the codebase to the Raspberry Pi Pico or (Pico W).
i- Use as below:
- Use as below:
```
>>> import PicoOled13
>>> display=PicoOled13.get()
Expand All @@ -33,7 +33,7 @@ i- Use as below:

## Acknowledgements

- The [pico-2fa-totp](https://github.com/eddmann/pico-2fa-totp) created by [Edd Mann](https://github.com/eddmann) which created the use-case for writing this driver
- The [pico-2fa-totp](https://github.com/eddmann/pico-2fa-totp) created by [Edd Mann](https://github.com/eddmann), and my derivative [fork ](https://github.com/samveen/pico-mpy-2fa-totp) which created the use-case for writing this driver

- Pico-oled-1.3 driver by [Waveshare](https://www.waveshare.com/wiki/Pico-OLED-1.3#Examples)

Expand Down

0 comments on commit c9ddd75

Please sign in to comment.