From c03725e736b890839fb76e0835c0667102fc5ef7 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 22:32:18 +0100 Subject: [PATCH] The Big Rename Rename the library to Kaleidoscope-Cycle, and follow up with other renames, too. Signed-off-by: Gergely Nagy --- README.md | 10 +++++----- examples/Cycle/Cycle.ino | 11 ++++++----- library.properties | 10 +++++----- src/{Akela-Cycle.h => Kaleidoscope-Cycle.h} | 4 ++-- src/{Akela => Kaleidoscope}/Cycle.cpp | 11 ++++++----- src/{Akela => Kaleidoscope}/Cycle.h | 12 ++++++------ 6 files changed, 30 insertions(+), 28 deletions(-) rename src/{Akela-Cycle.h => Kaleidoscope-Cycle.h} (87%) rename src/{Akela => Kaleidoscope}/Cycle.cpp (90%) rename src/{Akela => Kaleidoscope}/Cycle.h (81%) diff --git a/README.md b/README.md index e998e6f2..d4f513de 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-Cycle +# Kaleidoscope-Cycle ![status][st:stable] @@ -24,7 +24,7 @@ each time the cycling key triggers. [cycleaction]: #cycleactionpreviouskey-cyclecount ```c++ -#include +#include // Somewhere in the keymap: Key_Cycle @@ -37,9 +37,9 @@ void cycleAction (Key previousKey, uint8_t cycleCount) { } void setup (void) { - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); - Keyboardio.use (&Cycle, NULL); + Kaleidoscope.use (&Cycle, NULL); } ``` @@ -96,4 +96,4 @@ method explained below. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-Cycle/blob/master/examples/Cycle/Cycle.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Cycle/blob/master/examples/Cycle/Cycle.ino diff --git a/examples/Cycle/Cycle.ino b/examples/Cycle/Cycle.ino index 1c70f38b..67122b23 100644 --- a/examples/Cycle/Cycle.ino +++ b/examples/Cycle/Cycle.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * 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 @@ -53,11 +54,11 @@ void cycleAction (Key previousKey, uint8_t cycleCount) { } void setup () { - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); - Keyboardio.use (&Cycle, NULL); + Kaleidoscope.use (&Cycle, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 793ec03d..886173eb 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-Cycle +name=Kaleidoscope-Cycle version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Key sequence cycling dead key. -paragraph=Key sequence cycling dead key. +maintainer=Gergely Nagy +sentence=Key sequence cycling dead key for Kaleidoscope. +paragraph=Key sequence cycling dead key for Kaleidoscope. category=Communication -url=https://github.com/keyboardio/Akela-Cycle +url=https://github.com/keyboardio/Kaleidoscope-Cycle architectures=avr dot_a_linkage=true diff --git a/src/Akela-Cycle.h b/src/Kaleidoscope-Cycle.h similarity index 87% rename from src/Akela-Cycle.h rename to src/Kaleidoscope-Cycle.h index 4eb036f4..b3a86460 100644 --- a/src/Akela-Cycle.h +++ b/src/Kaleidoscope-Cycle.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * 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/Cycle.cpp b/src/Kaleidoscope/Cycle.cpp similarity index 90% rename from src/Akela/Cycle.cpp rename to src/Kaleidoscope/Cycle.cpp index fc85b664..01bac302 100644 --- a/src/Akela/Cycle.cpp +++ b/src/Kaleidoscope/Cycle.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,11 +16,12 @@ * along with this program. If not, see . */ -#include +#include +#include -using namespace Akela::Ranges; +using namespace KaleidoscopePlugins::Ranges; -namespace Akela { +namespace KaleidoscopePlugins { // --- state --- Key Cycle::lastNonCycleKey; uint8_t Cycle::cycleCount; @@ -96,4 +97,4 @@ void cycleAction (Key previousKey, uint8_t cycleCount) { } -Akela::Cycle Cycle; +KaleidoscopePlugins::Cycle Cycle; diff --git a/src/Akela/Cycle.h b/src/Kaleidoscope/Cycle.h similarity index 81% rename from src/Akela/Cycle.h rename to src/Kaleidoscope/Cycle.h index 4b98d831..04e3158a 100644 --- a/src/Akela/Cycle.h +++ b/src/Kaleidoscope/Cycle.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Cycle -- Key sequence cycling dead key for Kaleidoscope. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,17 +18,17 @@ #pragma once -#include +#include -#define Key_Cycle (Key){ .raw = Akela::Ranges::CYCLE } +#define Key_Cycle (Key){ .raw = KaleidoscopePlugins::Ranges::CYCLE } #define cycleThrough(...) ({ \ static const Key __k[] PROGMEM = { __VA_ARGS__ }; \ Cycle.replace (sizeof (__k) / sizeof (Key), &__k[0]); \ }) -namespace Akela { - class Cycle : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class Cycle : public KaleidoscopePlugin { public: Cycle (void); @@ -47,4 +47,4 @@ namespace Akela { void cycleAction (Key previousKey, uint8_t cycleCount); -extern Akela::Cycle Cycle; +extern KaleidoscopePlugins::Cycle Cycle;