From fc026f59af9ae87c1384ce9d46908e39d3e04f8b Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sun, 12 Feb 2017 00:07:19 +0100 Subject: [PATCH] The Big Rename Rename the library to Kaleidoscope-Unicode, and follow up with other renames. Signed-off-by: Gergely Nagy --- README.md | 19 ++++++++++--------- examples/Unicode/Unicode.ino | 13 +++++++------ library.properties | 8 ++++---- ...Akela-Unicode.h => Kaleidoscope-Unicode.h} | 4 ++-- src/{Akela => Kaleidoscope}/Unicode.cpp | 8 ++++---- src/{Akela => Kaleidoscope}/Unicode.h | 12 ++++++------ 6 files changed, 33 insertions(+), 31 deletions(-) rename src/{Akela-Unicode.h => Kaleidoscope-Unicode.h} (89%) rename src/{Akela => Kaleidoscope}/Unicode.cpp (96%) rename src/{Akela => Kaleidoscope}/Unicode.h (82%) diff --git a/README.md b/README.md index 9d6c919b..ad2679b0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-Unicode +# Kaleidoscope-Unicode ![status][st:stable] @@ -16,15 +16,16 @@ codepoints. ## Using the extension Using the extension is as simple as including the header, registering it with -`Keyboardio.use()`, and then using any of the methods provided by the `Unicode` +`Kaleidoscope.use()`, and then using any of the methods provided by the `Unicode` singleton object. ```c++ -#include +#include +#include void setup (void) { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&Unicode, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&Unicode, NULL); Unicode.type (0x2328); } @@ -80,14 +81,14 @@ functionality. ### `unicodeCustomStart()` -> If the host OS type is set to `Akela::HostOS::Custom`, then this function will +> If the host OS type is set to `Kaleidoscope::HostOS::Custom`, then this function will > be called whenever the [`.start()`](#start) method is called. The default > implementation does nothing, and should be overridden to implement the custom > magic needed to enter unicode input mode. ### `unicodeCustomInput()` -> If the host OS type is set to `Akela::HostOS::Custom`, then this function will +> If the host OS type is set to `Kaleidoscope::HostOS::Custom`, then this function will > be called whenever the [`.input()`](#input) method is called. The default > implementation does nothing, and should be overridden to implement the custom > magic needed while inputting the hex code itself (such as holding additional @@ -95,7 +96,7 @@ functionality. ### `unicodeCustomEnd()` -> If the host OS type is set to `Akela::HostOS::Custom`, then this function will +> If the host OS type is set to `Kaleidoscope::HostOS::Custom`, then this function will > be called whenever the [`.end()`](#end) method is called. The default > implementation does nothing, and should be overridden to implement the custom > magic needed to leave unicode input mode. @@ -105,4 +106,4 @@ functionality. Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-Unicode/blob/master/examples/Unicode/Unicode.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Unicode/blob/master/examples/Unicode/Unicode.ino diff --git a/examples/Unicode/Unicode.ino b/examples/Unicode/Unicode.ino index a717df92..9a5cddc9 100644 --- a/examples/Unicode/Unicode.ino +++ b/examples/Unicode/Unicode.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Unicode -- Unicode input helpers * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,9 +16,10 @@ * along with this program. If not, see . */ -#define AKELA_HOSTOS_GUESSER 1 +#define KALEIDOSCOPE_HOSTOS_GUESSER 1 -#include +#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -42,12 +43,12 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; void setup () { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&Unicode, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&Unicode, NULL); Unicode.type (0x2328); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index bb6e2840..bcdad466 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-Unicode +name=Kaleidoscope-Unicode version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Unicode input helpers for Keyboardio boards. +maintainer=Gergely Nagy +sentence=Unicode input helpers for Kaleidoscope. paragraph=Provides functions to help with inputting Unicode. category=Communication -url=https://github.com/keyboardio/Akela-Unicode +url=https://github.com/keyboardio/Kaleidoscope-Unicode architectures=avr dot_a_linkage=true diff --git a/src/Akela-Unicode.h b/src/Kaleidoscope-Unicode.h similarity index 89% rename from src/Akela-Unicode.h rename to src/Kaleidoscope-Unicode.h index d849e5ff..343e3c56 100644 --- a/src/Akela-Unicode.h +++ b/src/Kaleidoscope-Unicode.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Unicode -- Unicode input helpers * 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/Unicode.cpp b/src/Kaleidoscope/Unicode.cpp similarity index 96% rename from src/Akela/Unicode.cpp rename to src/Kaleidoscope/Unicode.cpp index 6dadf5f5..98a51918 100644 --- a/src/Akela/Unicode.cpp +++ b/src/Kaleidoscope/Unicode.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Unicode -- Unicode input helpers * 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 { Unicode::Unicode (void) { } @@ -175,4 +175,4 @@ void unicodeCustomInput (void) { } -Akela::Unicode Unicode; +KaleidoscopePlugins::Unicode Unicode; diff --git a/src/Akela/Unicode.h b/src/Kaleidoscope/Unicode.h similarity index 82% rename from src/Akela/Unicode.h rename to src/Kaleidoscope/Unicode.h index 37f09020..71712b23 100644 --- a/src/Akela/Unicode.h +++ b/src/Kaleidoscope/Unicode.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Unicode -- Unicode input helpers * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,11 +18,11 @@ #pragma once -#include -#include +#include +#include -namespace Akela { - class Unicode : public KeyboardioPlugin { +namespace KaleidoscopePlugins { + class Unicode : public KaleidoscopePlugin { public: Unicode (void); @@ -43,4 +43,4 @@ void unicodeCustomStart (void); void unicodeCustomEnd (void); void unicodeCustomInput (void); -extern Akela::Unicode Unicode; +extern KaleidoscopePlugins::Unicode Unicode;