diff --git a/README.md b/README.md index 52b8fb4..73230d2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # Arduino_GigaDisplay -Minimal library for controlling the built-in RGB on the GIGA Display Shield via the IS31FL3197 driver (I2C). +This library contains a set of examples to use the [GIGA Display Shield](docs.arduino.cc/hardware/giga-display-shield). Upon installing this library from the Arduino IDE, the following libraries will also be installed: +- [ArduinoGraphics](https://github.com/arduino-libraries/ArduinoGraphics) +- [Arduino_GigaDisplayTouch](https://github.com/arduino-libraries/Arduino_GigaDisplayTouch) +- [Arduino_BMI270_BMM150](https://github.com/arduino-libraries/Arduino_BMI270_BMM150) + +It will also install the [lvgl](https://github.com/lvgl/lvgl) library, which is required for a large number of examples in this repository. + +>For any issues with the examples, please visit the repository of the library in the links above. + +## GigaDisplayRGB + +This library has a class called `GigaDisplayRGB`, which is used to control the built-in RGB on the GIGA Display Shield via the IS31FL3197 driver (I2C). diff --git a/library.properties b/library.properties index 910481a..6911c04 100644 --- a/library.properties +++ b/library.properties @@ -8,4 +8,4 @@ category=Device Control url=https://www.arduino.cc/ architectures=mbed_giga includes=Arduino_GigaDisplay.h -depends=Arduino_BMI270_BMM150,ArduinoGraphics,lvgl \ No newline at end of file +depends=Arduino_BMI270_BMM150,Arduino_GigaDisplayTouch,ArduinoGraphics,lvgl \ No newline at end of file