diff --git a/README.md b/README.md index dbb97843..cf2b3f41 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-SpaceCadet +# Kaleidoscope-SpaceCadet ![status][st:stable] @@ -30,11 +30,12 @@ Using the plugin with its defaults is as simple as including the header, and enabling the plugin: ```c++ -#include +#include +#include void setup () { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&SpaceCadetShift, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&SpaceCadetShift, NULL); } ``` @@ -59,7 +60,7 @@ The plugin has a number of methods available on the `SpaceCadetShift` object: ```c++ void setup () { SpaceCadetShift.configure(Key_8, Key_9); - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); } ``` @@ -87,4 +88,4 @@ void setup () { Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-SpaceCadet/blob/master/examples/SpaceCadet/SpaceCadet.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-SpaceCadet/blob/master/examples/SpaceCadet/SpaceCadet.ino diff --git a/examples/SpaceCadet/SpaceCadet.ino b/examples/SpaceCadet/SpaceCadet.ino index 91a5d3b4..1be9b3f5 100644 --- a/examples/SpaceCadet/SpaceCadet.ino +++ b/examples/SpaceCadet/SpaceCadet.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-SpaceCadet -- Space Cadet Shift * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,7 +16,8 @@ * along with this program. If not, see . */ -#include +#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -40,10 +41,10 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; void setup () { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&SpaceCadetShift, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&SpaceCadetShift, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index efad938d..947f63a7 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-SpaceCadet +name=Kaleidoscope-SpaceCadet version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Space Cadet Shift for Keyboardio boards. +maintainer=Gergely Nagy +sentence=Space Cadet Shift for Kaleidoscope. paragraph=Turns Left/Right shift into Space Cadet Shifts. category=Communication -url=https://github.com/keyboardio/Akela-SpaceCadet +url=https://github.com/keyboardio/Kaleidoscope-SpaceCadet architectures=avr dot_a_linkage=true diff --git a/src/Akela-SpaceCadet.h b/src/Kaleidoscope-SpaceCadet.h similarity index 88% rename from src/Akela-SpaceCadet.h rename to src/Kaleidoscope-SpaceCadet.h index 0cc02bb3..e9199daa 100644 --- a/src/Akela-SpaceCadet.h +++ b/src/Kaleidoscope-SpaceCadet.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-SpaceCadet -- Space Cadet Shift * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,4 +18,4 @@ #pragma once -#include +#include diff --git a/src/Akela/SpaceCadet.cpp b/src/Kaleidoscope/SpaceCadet.cpp similarity index 95% rename from src/Akela/SpaceCadet.cpp rename to src/Kaleidoscope/SpaceCadet.cpp index bc57ece4..fb7c971f 100644 --- a/src/Akela/SpaceCadet.cpp +++ b/src/Kaleidoscope/SpaceCadet.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-SpaceCadet -- Space Cadet Shift * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,9 +16,9 @@ * along with this program. If not, see . */ -#include +#include -namespace Akela { +namespace KaleidoscopePlugins { uint8_t SpaceCadetShift::parenNeeded; uint32_t SpaceCadetShift::startTime; @@ -118,4 +118,4 @@ namespace Akela { }; -Akela::SpaceCadetShift SpaceCadetShift; +KaleidoscopePlugins::SpaceCadetShift SpaceCadetShift; diff --git a/src/Akela/SpaceCadet.h b/src/Kaleidoscope/SpaceCadet.h similarity index 84% rename from src/Akela/SpaceCadet.h rename to src/Kaleidoscope/SpaceCadet.h index 5e5d987e..56041341 100644 --- a/src/Akela/SpaceCadet.h +++ b/src/Kaleidoscope/SpaceCadet.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-SpaceCadet -- Space Cadet Shift * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,10 +18,10 @@ #pragma once -#include +#include -namespace Akela { - class SpaceCadetShift : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class SpaceCadetShift : public KaleidoscopePlugin { public: SpaceCadetShift (void); @@ -42,4 +42,4 @@ namespace Akela { }; }; -extern Akela::SpaceCadetShift SpaceCadetShift; +extern KaleidoscopePlugins::SpaceCadetShift SpaceCadetShift;