diff --git a/README.md b/README.md index e5da3f400c46281be18ee66658eab3dd264a476e..17784f4556bd797960cf4e542b4a1560f30fd741 100644 --- a/README.md +++ b/README.md @@ -25,3 +25,29 @@ The SSD1306Demo is a very comprehensive example demonstrating the most important ## Fonts Fonts are defined in a proprietary but open format. I wrote a program that converts any TrueType font into this format. Once the code is useful enough I will publish it or make it available as Webapplication (SaaS), where you can make any font you like available to the library. + +## Demo + +### Frame 1 + +This frame shows three things: + * How to draw an xbm image + * How to draw a static text which is not moved by the frame transition + * The active/inactive frame indicators + +### Frame 2 + + +Currently there are one fontface with three sizes included in the library: Arial 10, 16 and 24. Once the converter is published you will be able to convert any ttf font into the used format. + +### Frame 3 + + + +This frame demonstrates the text alignment. The coordinates in the frame show relative to which position the texts have been rendered. + +### Frame 4 + + + +This shows how to use define a maximum width after which the driver automatically wraps a word to the next line. This comes in very handy if you have longer texts to display.