|
1 |
| -Micro OLED Breakout |
2 |
| -=================== |
| 1 | +SparkFun Micro OLED Breakout Arduino Library |
| 2 | +======================================== |
3 | 3 |
|
4 |
| -[ |
5 |
| -<br>*Micro OLED Breakout (LCD-13003)*](https://www.sparkfun.com/products/13003) |
| 4 | + |
6 | 5 |
|
7 |
| -The Micro OLED Breakout Board breaks out a small monochrome, blue-on-black OLED. It’s “micro”, but it still packs a punch – the OLED display is crisp, and you can fit a deceivingly large amount of graphics on there. This breakout is perfect for adding graphics to your next Arduino project, displaying diagnostic information without resorting to serial output, and teaching a little game theory while creating a fun, Arduino-based video game. Most important of all, though, is the Micro OLED is easy to control over either an SPI or I2C interface. |
| 6 | +[*SparkFun Micro OLED Breakout (LCD-13003)*](https://www.sparkfun.com/products/13003) |
| 7 | + |
| 8 | +An Arduino library that allows you to draw shapes and text on the Micro OLED display. |
8 | 9 |
|
9 | 10 | Repository Contents
|
10 | 11 | -------------------
|
11 |
| -* **/Firmware** - Arduino library and example sketches. |
12 |
| -* **/Hardware** - All Eagle design files (.brd, .sch) |
13 |
| -* **/Production** - Test bed files and production panel files |
| 12 | + |
| 13 | +* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. |
| 14 | +* **/extras** - Additional documentation for the user. These files are ignored by the IDE. |
| 15 | +* **/src** - Source files for the library (.cpp, .h). |
| 16 | +* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. |
| 17 | +* **library.properties** - General library properties for the Arduino package manager. |
| 18 | + |
| 19 | +Documentation |
| 20 | +-------------- |
| 21 | + |
| 22 | +* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library. |
| 23 | +* **[Product Repository](https://github.com/sparkfun/Micro_OLED_Breakout)** - Main repository (including hardware files) for the Micro OLED Breakout. |
| 24 | +* **[Hookup Guide](https://learn.sparkfun.com/tutorials/micro-oled-breakout-hookup-guide)** - Basic hookup guide for the Micro OLED Breakout. |
| 25 | + |
| 26 | +Products that use this Library |
| 27 | +--------------------------------- |
| 28 | + |
| 29 | +* [Micro OLED Breakout](https://www.sparkfun.com/products/13003)- A breakout for the monochrome 64x48 OLED. |
| 30 | + |
| 31 | +Version History |
| 32 | +--------------- |
| 33 | + |
| 34 | +* [TODO](TODO) - Description |
14 | 35 |
|
15 | 36 | License Information
|
16 | 37 | -------------------
|
17 |
| -The hardware is released under [Creative Commons Share-alike 3.0](http://creativecommons.org/licenses/by-sa/3.0/). |
18 |
| -All other code is open source so please feel free to do anything you want with it; you buy me a beer if you use this and we meet someday ([Beerware license](http://en.wikipedia.org/wiki/Beerware)). |
| 38 | + |
| 39 | +This product is _**open source**_! |
| 40 | + |
| 41 | +The **code** is released under the GPL v3 license. See the included LICENSE.md for more information. |
| 42 | + |
| 43 | +Distributed as-is; no warranty is given. |
| 44 | + |
| 45 | +- Your friends at SparkFun. |
0 commit comments