Skip to content

Commit 6a5d11d

Browse files
author
Kirk
committed
finalization for v1.0
1 parent c46f914 commit 6a5d11d

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

docs/index.md

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,27 @@
22

33
![SparkFun Qwiic OLED Arduino Library](img/OLEDLibBanner.png "SparkFun Qwiic OLED Arduino Library")
44

5-
==TODO: Add Wonderful Intro Here==
5+
The SparkFun Qwiic OLED Arduino Library is a single graphics module that supports all SparkFun OLED boards based on the SSD1306 from Solomon Systech. Prior to this library, three different libraries were used to support our four different OLED boards.
66

7-
## Supported Products
7+
The SparkFun Qwiic OLED Library delivers a common implementation for all our Qwiic OLED products, delivering a unified, fast, and efficient solution that implements a familiar and easy to understand user experience.
8+
9+
### Key Features
10+
* Implements common graphics capabilities: pixel, line, rectangle, filled rectangle, circle, filled circle, bitmap, text and raster operators (i.e. XOR).
11+
* Smart data transfer to the device – only sends _dirty_ regions of the graphics buffer to the OLED device, not the entire buffer.
12+
* High performance – 2x faster than our previous OLED library, often much higher.
13+
* Efficient memory usage. No dynamic memory utilized. Static resources are loaded once, and only on explicit declaration.
14+
* Implements a familiar interface, making migration from older libraries straight forward
15+
16+
### Getting Started
17+
18+
The [Getting Started Page](software.md) outlines library installation and the general use of the qwiic OLED library.
19+
20+
Detailed examples are included as part of the library installation process and available in the Arduino IDE `File > Examples >` menu. A walk-thru of key examples is contained in the [Examples](sparkfun-qwiic-oled-arduino-library-examples/ex_01_hello/) section of this documentation set.
21+
22+
23+
A full [API Reference](api_device.md) is also provided for the library.
24+
25+
### Supported Products
826

927
The SparkFun Qwiic OLED Arduino Library supports the following SparFun Products
1028

@@ -32,11 +50,18 @@ The SparkFun Qwiic OLED Arduino Library supports the following SparFun Products
3250
</tr>
3351
</table>
3452

35-
## Getting Started
3653

37-
The [Getting Started Page] outlines library installation and the general use of the qwiic OLED library.
3854

39-
Detailed examples are included as part of the library installation process and available in the Arduino IDE `File > Examples >` menu.
55+
### Supported Microcontrollers - Arduino Environment
4056

41-
A complete listing of the qwiic OLED library API is available on the [API Page].
57+
* [Artemis](https://www.sparkfun.com/products/15574)
58+
* [SAMD51](https://www.sparkfun.com/products/14713)
59+
* [ESP32](https://www.sparkfun.com/products/15663)
60+
* [STM32](https://www.sparkfun.com/products/17712)
61+
* [SAMD21](https://www.sparkfun.com/products/14812)
62+
* [nrf5280](https://www.sparkfun.com/products/15025)
63+
* [Teensy](https://www.sparkfun.com/products/16402)
64+
* [ATMega328](https://www.sparkfun.com/products/18158)
4265

66+
### License
67+
The SparkFun Qwiic OLED Arduino Library is licensed using the Open Source MIT License

0 commit comments

Comments
 (0)