search

lexus2k / ssd1306

Driver for SSD1306, SSD1331, SSD1351, IL9163, ILI9341, ST7735, PCD8544, Nokia 5110 displays running on Arduino/ESP32/Linux (Rasperry) platforms
MIT License
655 stars 125 forks source link

Where is the documentation for this library!? I just want to know how to use it. #67

Closed pikipupiba closed 5 years ago

pikipupiba commented 5 years ago

It might be because I'm new to git hub but I cannot for the life of me find any actual documentation of how to use this library.

For example, the Display class and what fonts are available to the SetFont member function.

lexus2k commented 5 years ago

Hello,

As it is said in main README.md file: Doxygen documentation can be found at github.io site. Please, take into account, that main library interface is C, and not C++. This is to reduce memory consumption for small controllers. The library also has some C++ API, allowing to perform powerful graphics operations.

The API, you would like to use (For example, the Display class.) is in development, and you can check ssd1306_demo in 2.0.0_dev branch. To figure out how to use official library releases, please refer to examples