Skip to content

Commit a63beee

Browse files
Add links for example readme
1 parent e0d9bfc commit a63beee

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

examples/README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,40 @@ Below is a brief summary of each of the example programs included in this reposi
44
NOTE: Any numbering of examples is to retain consistency with the Arduino library from which this was ported.
55

66
## Ex1 Splash Screen
7-
Simple Example for an OLED Display that displays the SparkFun splash screen
7+
Simple Example for an OLED Display that displays the SparkFun splash screen.
8+
9+
The key methods showcased by this example are:
10+
- [clear()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#adf21b24793a1df5f9cb7178e8591b4c8)
11+
- [display()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#abfb4b7fd27d21fd286fcc9888b4c55e1)
12+
- [add_logo()](https://docs.sparkfun.com/qwiic_oled_base_py/namespaceqwiic__oled_1_1oled__logos.html#a97c1ff57127bf2a9e6d8eb729f909ea3)
813

914
## Ex2 Hello World
10-
"Hello World" Example for an OLED Display
15+
Example for writing "Hello World" to an OLED Display.
16+
17+
The key methods showcased by this example are:
18+
- [print()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#ade9495b0295893c40478470ca315bb37)
1119

1220
## Ex3 Demo
13-
An example showing various features of the display driver for Qwiic OLED displays
21+
A full-featured example showing various features of the display driver for Qwiic OLED displays.
22+
23+
The key methods showcased by this example are:
24+
- [get_lcd_width()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#ae2ac53f339f6033e72694425812e81fa)
25+
- [get_lcd_height()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#afa662f7b663c804789dfe9e982e29bb7)
26+
- [line()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#a6de8311ad922e2405bb262ad97ce14d0)
27+
- [rect()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#a7c8e27f4cfaca79086c17a5f93f95d1f)
28+
- [rect_fill()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#a371a1f6a3532a667164d75e5d73ea44a)
29+
- [circle()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#aa21279df594947e00f935ac351b1945c)
30+
- [set_font_type()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#aa91749e627960b5e31423acc06b9a796)
31+
- [set_cursor()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#ac3faf8203fb6a1aa7feed9535168aeb6)
1432

1533
## Ex4 Cube
16-
Cube Example for a Qwiic OLED Device
34+
Rotating cube example for a Qwiic OLED Device.
35+
36+
The key methods showcased by this example are:
37+
- [line()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#a6de8311ad922e2405bb262ad97ce14d0)
1738

1839
## Ex5 Micro Bitmap
1940
Example for the Qwiic Micro OLED display that displays Bender's face!
2041

21-
42+
The key methods showcased by this example are:
43+
- [draw_bitmap()](https://docs.sparkfun.com/qwiic_oled_base_py/classqwiic__oled_1_1qwiic__oled__base_1_1_qwiic_oled_base.html#aa1642c776a2f1ba9a7f01d006a184927)

0 commit comments

Comments
 (0)