Skip to content

Commit 1254ef9

Browse files
committed
Add upgrade guide
1 parent eb57ad4 commit 1254ef9

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![Build Status](https://travis-ci.org/ThingPulse/esp8266-oled-ssd1306.svg?branch=master)](https://travis-ci.org/ThingPulse/esp8266-oled-ssd1306)
22

3-
# ESP8266 OLED SSD1306
3+
# ESP8266 OLED SSD1306
44

55
> We just released version 3.0.0. Please have a look at our [upgrade guide](UPGRADE-3.0.md)
66
@@ -26,6 +26,8 @@ Check out the examples folder for a few comprehensive demonstrations how to use
2626

2727
The API changed a lot with the 3.0 release. If you were using this library with older versions please have a look at the [Upgrade Guide](UPGRADE-3.0.md).
2828

29+
Going from 3.x version to 4.0 a lot of internals changed and compatibility for more displays was added. Please read the [Upgrade Guide](UPGRADE-4.0.md)
30+
2931
## Features
3032

3133
* Draw pixels at given coordinates

UPGRADE-4.0.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Upgrade from 3.x to 4.0
2+
3+
There is one change that breaks compatibility with older versions. You'll have to change data type for all your binary resources such as images and fonts from
4+
5+
```c
6+
const char MySymbol[] PROGMEM = {
7+
```
8+
9+
to
10+
11+
```c
12+
const uint8_t MySymbol[] PROGMEM = {
13+
```

0 commit comments

Comments
 (0)