Update the docs & example about the EEPROMSettings dependency

We started to depend on EEPROMSettings. For that to work, we need to explicitly
initialize it. Lets do that.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
pull/389/head
Gergely Nagy 6 years ago
parent 90b2247465
commit 4c3c8f4036
No known key found for this signature in database
GPG Key ID: AC1E90BAC433F68F

@ -24,9 +24,10 @@ the box, without any further configuration:
```c++
#include <Kaleidoscope.h>
#include <Kaleidoscope-EEPROM-Settings.h>
#include <Kaleidoscope-TypingBreaks.h>
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.

@ -16,6 +16,7 @@
*/
#include <Kaleidoscope.h>
#include <Kaleidoscope-EEPROM-Settings.h>
#include <Kaleidoscope-TypingBreaks.h>
// *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();

Loading…
Cancel
Save