diff --git a/README.md b/README.md index c330c916..ca00e244 100644 --- a/README.md +++ b/README.md @@ -24,9 +24,10 @@ the box, without any further configuration: ```c++ #include +#include #include -KALEIDOSCOPE_INIT_PLUGINS(TypingBreaks); +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, TypingBreaks); void setup (void) { Kaleidoscope.setup (); @@ -100,9 +101,19 @@ properties. All times are in seconds. > Get or set the `.settings.right_hand_max_keys` property. +## Dependencies + +* [Kaleidoscope-EEPROM-Settings](https://github.com/keyboardio/Kaleidoscope-EEPROM-Settings) + ## Further reading Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. [plugin:example]: https://github.com/keyboardio/Kaleidoscope-TypingBreaks/blob/master/examples/TypingBreaks/TypingBreaks.ino + +## Upgrading + +Storing the settable settings in EEPROM was made mandatory in recent versions of +the plugin, and as such, it now depends on `Kaleidoscope-EEPROM-Settings`, which +should be initialized before this plugin is. diff --git a/examples/TypingBreaks/TypingBreaks.ino b/examples/TypingBreaks/TypingBreaks.ino index e36f83ed..2aeae008 100644 --- a/examples/TypingBreaks/TypingBreaks.ino +++ b/examples/TypingBreaks/TypingBreaks.ino @@ -16,6 +16,7 @@ */ #include +#include #include // *INDENT-OFF* @@ -40,7 +41,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; // *INDENT-ON* -KALEIDOSCOPE_INIT_PLUGINS(TypingBreaks); +KALEIDOSCOPE_INIT_PLUGINS(EEPROMSettings, TypingBreaks); void setup() { Kaleidoscope.setup();