From 916f69889e5d4b2b1dc2f34dda9596638887df73 Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 22:42:48 +0100 Subject: [PATCH] The Big Rename Rename the library to Kaleidoscope-Escape-OneShot, and follow up with other renames. Signed-off-by: Gergely Nagy --- README.md | 13 +++++++------ examples/Escape-OneShot/Escape-OneShot.ino | 13 +++++++------ library.properties | 6 +++--- ...cape-OneShot.h => Kaleidoscope-Escape-OneShot.h} | 4 ++-- src/{Akela => Kaleidoscope}/Escape-OneShot.cpp | 11 ++++++----- src/{Akela => Kaleidoscope}/Escape-OneShot.h | 10 +++++----- 6 files changed, 30 insertions(+), 27 deletions(-) rename src/{Akela-Escape-OneShot.h => Kaleidoscope-Escape-OneShot.h} (85%) rename src/{Akela => Kaleidoscope}/Escape-OneShot.cpp (81%) rename src/{Akela => Kaleidoscope}/Escape-OneShot.h (77%) diff --git a/README.md b/README.md index 68d01818..685d3242 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-Escape-OneShot +# Kaleidoscope-Escape-OneShot ![status][st:stable] @@ -16,13 +16,14 @@ To use the plugin, one needs to include the header, and activate it. No further configuration is necessary. ```c++ -#include -#include +#include +#include +#include void setup () { - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); - Keyboardio.use (&OneShot, &EscapeOneShot, NULL); + Kaleidoscope.use (&OneShot, &EscapeOneShot, NULL); } ``` @@ -37,4 +38,4 @@ The plugin provides the `EscapeOneShot` object, which has no public methods. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-Escape-OneShot/blob/master/examples/Escape-OneShot/Escape-OneShot.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Escape-OneShot/blob/master/examples/Escape-OneShot/Escape-OneShot.ino diff --git a/examples/Escape-OneShot/Escape-OneShot.ino b/examples/Escape-OneShot/Escape-OneShot.ino index 85b6baaf..b2c09863 100644 --- a/examples/Escape-OneShot/Escape-OneShot.ino +++ b/examples/Escape-OneShot/Escape-OneShot.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Escape-OneShot -- Turn ESC into a key that cancels OneShots, if active. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,8 +16,9 @@ * along with this program. If not, see . */ -#include -#include +#include +#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -63,10 +64,10 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { void setup () { OneShot.enableAuto (); - Keyboardio.use (&OneShot, &EscapeOneShot, NULL); - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.use (&OneShot, &EscapeOneShot, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 5ff354ed..a57d0017 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-Escape-OneShot +name=Kaleidoscope-Escape-OneShot version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Turn ESC into a key that cancels OneShots, if active. paragraph=Cancel one-shots, if any are active, otherwise act as an ESC key. category=Communication -url=https://github.com/keyboardio/Akela-Escape-OneShot +url=https://github.com/keyboardio/Kaleidoscope-Escape-OneShot architectures=avr dot_a_linkage=true diff --git a/src/Akela-Escape-OneShot.h b/src/Kaleidoscope-Escape-OneShot.h similarity index 85% rename from src/Akela-Escape-OneShot.h rename to src/Kaleidoscope-Escape-OneShot.h index 4c41e9c0..a3a9c912 100644 --- a/src/Akela-Escape-OneShot.h +++ b/src/Kaleidoscope-Escape-OneShot.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Escape-OneShot -- Turn ESC into a key that cancels OneShots, if active. * 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/Escape-OneShot.cpp b/src/Kaleidoscope/Escape-OneShot.cpp similarity index 81% rename from src/Akela/Escape-OneShot.cpp rename to src/Kaleidoscope/Escape-OneShot.cpp index 0d44a541..ee9d2cfc 100644 --- a/src/Akela/Escape-OneShot.cpp +++ b/src/Kaleidoscope/Escape-OneShot.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Escape-OneShot -- Turn ESC into a key that cancels OneShots, if active. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,10 +16,11 @@ * along with this program. If not, see . */ -#include -#include +#include +#include +#include -namespace Akela { +namespace KaleidoscopePlugins { EscapeOneShot::EscapeOneShot (void) { } @@ -45,4 +46,4 @@ namespace Akela { } }; -Akela::EscapeOneShot EscapeOneShot; +KaleidoscopePlugins::EscapeOneShot EscapeOneShot; diff --git a/src/Akela/Escape-OneShot.h b/src/Kaleidoscope/Escape-OneShot.h similarity index 77% rename from src/Akela/Escape-OneShot.h rename to src/Kaleidoscope/Escape-OneShot.h index 16e529e9..b5669e66 100644 --- a/src/Akela/Escape-OneShot.h +++ b/src/Kaleidoscope/Escape-OneShot.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Escape-OneShot -- Turn ESC into a key that cancels OneShots, if active. * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,10 +16,10 @@ * along with this program. If not, see . */ -#include +#include -namespace Akela { - class EscapeOneShot : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class EscapeOneShot : public KaleidoscopePlugin { public: EscapeOneShot (void); @@ -30,4 +30,4 @@ namespace Akela { }; }; -extern Akela::EscapeOneShot EscapeOneShot; +extern KaleidoscopePlugins::EscapeOneShot EscapeOneShot;