Skip to content

Commit 69d1931

Browse files
authored
Update README.md
1 parent 3f72455 commit 69d1931

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Adafruit GFX Library fork supporting SSD1306/SH1106 displays on mbed 5/6
1+
## Adafruit GFX Library original text:
22

33
This is the core graphics library for all our displays, providing a common set of graphics primitives (points, lines, circles, etc.). It needs to be paired with a hardware-specific library for each display device we carry (to handle the lower-level functions).
44

@@ -10,7 +10,7 @@ All text above must be included in any redistribution.
1010

1111
This library carries exactly the same licensing terms as the original, any changes made in this repo are assumed to be under the same terms as the original too.
1212

13-
## Summary
13+
## Library fork supporting SSD1306/SH1106 displays on mbed 5/6 RTOS
1414

1515
Although many newer mbed RTOS chipsets have inbuilt hardware LCD drivers, there's sometimes a need to use a more basic display, such as an OLED or LCD unit. This is a fork of the Adafruit_GFX library with changes to run on mbed 5/6 RTOS. It is derived from a few sources:
1616

@@ -38,8 +38,6 @@ Every fork should state what it's purpose is. This fork is purely to provide mbe
3838

3939
Important note about bug fixes: do not put in PRs for the core graphics class here, only mbed and display specific fixes will be applied. Instead apply any changes to the core and then we'll re-pull the change here.
4040

41-
42-
4341
# Useful Resources
4442

4543
- Image2Code: This is a handy Java GUI utility to convert a BMP file into the array code necessary to display the image with the drawBitmap function. Check out the code at ehubin's GitHub repository: https://github.com/ehubin/Adafruit-GFX-Library/tree/master/Img2Code
@@ -58,4 +56,4 @@ The PRIME DIRECTIVE is to maintain backward compatibility with existing Arduino
5856

5957
Highly unlikely to merge any changes for additional or incompatible font formats (see Prime Directive above). There are already two formats and the code is quite bloaty there as it is (this also creates liabilities for tools and documentation). If you *must* have a more sophisticated font format, consider creating a fork with the features required for your project. For similar reasons, also unlikely to add any more bitmap formats, it's getting messy.
6058

61-
Please don't reformat code for the sake of reformatting code. The resulting large "visual diff" makes it impossible to untangle actual bug fixes from merely rearranged lines.
59+
Please don't reformat code for the sake of reformatting code. The resulting large "visual diff" makes it impossible to untangle actual bug fixes from merely rearranged lines.

0 commit comments

Comments
 (0)