From 204d450239e43db46bdc1fc32b397430b361ca61 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 12 Feb 2017 00:04:11 +0100 Subject: [PATCH] The Big Rename Rename the library to Kaleidoscope-TopsyTurvy, and follow up with other renames. Signed-off-by: Gergely Nagy --- README.md | 11 ++++++----- examples/TopsyTurvy/TopsyTurvy.ino | 11 ++++++----- library.properties | 6 +++--- src/{Akela-TopsyTurvy.h => Kaleidoscope-TopsyTurvy.h} | 4 ++-- src/{Akela => Kaleidoscope}/TopsyTurvy.cpp | 8 ++++---- src/{Akela => Kaleidoscope}/TopsyTurvy.h | 10 +++++----- 6 files changed, 26 insertions(+), 24 deletions(-) rename src/{Akela-TopsyTurvy.h => Kaleidoscope-TopsyTurvy.h} (85%) rename src/{Akela => Kaleidoscope}/TopsyTurvy.cpp (93%) rename src/{Akela => Kaleidoscope}/TopsyTurvy.h (82%) diff --git a/README.md b/README.md index 9b0f81ff..63c33a07 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-TopsyTurvy +# Kaleidoscope-TopsyTurvy ![status][st:stable] @@ -17,7 +17,8 @@ To use the plugin, one needs to include the header, create a list, and configure the provided `TopsyTurvy` object to use the dictionary: ```c++ -#include +#include +#include static const Key topsyTurvyList[] PROGMEM = { Key_1, Key_2, Key_3, Key_4, Key_5, @@ -28,8 +29,8 @@ static const Key topsyTurvyList[] PROGMEM = { void setup () { TopsyTurvy.configure (topsyTurvyList); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&TopsyTurvy, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&TopsyTurvy, NULL); } ``` @@ -59,4 +60,4 @@ The plugin provides the `TopsyTurvy` object, with the following methods: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-TopsyTurvy/blob/master/examples/TopsyTurvy/TopsyTurvy.ino diff --git a/examples/TopsyTurvy/TopsyTurvy.ino b/examples/TopsyTurvy/TopsyTurvy.ino index a4f8f160..6648eab4 100644 --- a/examples/TopsyTurvy/TopsyTurvy.ino +++ b/examples/TopsyTurvy/TopsyTurvy.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 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 @@ -48,10 +49,10 @@ static const Key topsyTurvyList[] PROGMEM = { void setup () { TopsyTurvy.configure (topsyTurvyList); - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&TopsyTurvy, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&TopsyTurvy, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 0daf8a57..719e1ac5 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-TopsyTurvy +name=Kaleidoscope-TopsyTurvy version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Turn the effect of Shift upside down for certain keys. paragraph=Make it possible to send an unshifted symbol with Shift held. category=Communication -url=https://github.com/keyboardio/Akela-TopsyTurvy +url=https://github.com/keyboardio/Kaleidoscope-TopsyTurvy architectures=avr dot_a_linkage=true diff --git a/src/Akela-TopsyTurvy.h b/src/Kaleidoscope-TopsyTurvy.h similarity index 85% rename from src/Akela-TopsyTurvy.h rename to src/Kaleidoscope-TopsyTurvy.h index 53e39235..2eace1b4 100644 --- a/src/Akela-TopsyTurvy.h +++ b/src/Kaleidoscope-TopsyTurvy.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 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/TopsyTurvy.cpp b/src/Kaleidoscope/TopsyTurvy.cpp similarity index 93% rename from src/Akela/TopsyTurvy.cpp rename to src/Kaleidoscope/TopsyTurvy.cpp index e37a1ff6..9ec1094c 100644 --- a/src/Akela/TopsyTurvy.cpp +++ b/src/Kaleidoscope/TopsyTurvy.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,11 +16,11 @@ * along with this program. If not, see . */ -#include +#include #define TOPSYTURVY 0b01000000 -namespace Akela { +namespace KaleidoscopePlugins { const Key *TopsyTurvy::topsyTurvyList = NULL; uint8_t TopsyTurvy::topsyTurvyModState; @@ -107,4 +107,4 @@ namespace Akela { }; -Akela::TopsyTurvy TopsyTurvy; +KaleidoscopePlugins::TopsyTurvy TopsyTurvy; diff --git a/src/Akela/TopsyTurvy.h b/src/Kaleidoscope/TopsyTurvy.h similarity index 82% rename from src/Akela/TopsyTurvy.h rename to src/Kaleidoscope/TopsyTurvy.h index d62e828f..40a8a02d 100644 --- a/src/Akela/TopsyTurvy.h +++ b/src/Kaleidoscope/TopsyTurvy.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-TopsyTurvy -- Turn the effect of Shift upside down for certain keys * Copyright (C) 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 TopsyTurvy: public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class TopsyTurvy: public KaleidoscopePlugin { public: TopsyTurvy (void); @@ -41,4 +41,4 @@ namespace Akela { }; }; -extern Akela::TopsyTurvy TopsyTurvy; +extern KaleidoscopePlugins::TopsyTurvy TopsyTurvy;