The Big Rename

Rename the library to Kaleidoscope-ShapeShifter, and follow up with other
renames.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/389/head^2
Gergely Nagy 8 years ago
parent e5fabbce79
commit eabc4a9872

@ -1,4 +1,4 @@
# Akela-ShapeShifter # Kaleidoscope-ShapeShifter
![status][st:stable] ![status][st:stable]
@ -22,9 +22,10 @@ To use the plugin, one needs to include the header, create a dictionary, and
configure the provided `ShapeShifter` object to use the dictionary: configure the provided `ShapeShifter` object to use the dictionary:
```c++ ```c++
#include <Akela-ShapeShifter.h> #include <Kaleidoscope.h>
#include <Kaleidoscope-ShapeShifter.h>
static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = {
{Key_1, Key_4}, {Key_1, Key_4},
{Key_4, Key_1}, {Key_4, Key_1},
{Key_NoKey, Key_NoKey}, {Key_NoKey, Key_NoKey},
@ -33,8 +34,8 @@ static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM =
void setup () { void setup () {
ShapeShifter.configure (shapeShiftDictionary); ShapeShifter.configure (shapeShiftDictionary);
Keyboardio.setup (KEYMAP_SIZE); Kaleidoscope.setup (KEYMAP_SIZE);
Keyboardio.use (&ShapeShifter, NULL); Kaleidoscope.use (&ShapeShifter, NULL);
} }
``` ```
@ -49,9 +50,9 @@ The plugin provides the `ShapeShifter` object, with the following methods:
### `.configure(dictionary)` ### `.configure(dictionary)`
> Tells `ShapeShifter` to use the specified dictionary. The dictionary is an > Tells `ShapeShifter` to use the specified dictionary. The dictionary is an
> array of `Akela::ShapeShifter::dictionary_t` elements, which is just a very > array of `KaleidoscopePlugins::ShapeShifter::dictionary_t` elements, which is
> verbose way of saying that its a pair of keys. The first one is the one to > just a very verbose way of saying that its a pair of keys. The first one is
> replace, and the other is to replace it with. > the one to replace, and the other is to replace it with.
> >
> Be aware that the replacement key will be pressed with `Shift` held, so do > Be aware that the replacement key will be pressed with `Shift` held, so do
> keep that in mind! > keep that in mind!
@ -72,4 +73,4 @@ The plugin provides the `ShapeShifter` object, with the following methods:
Starting from the [example][plugin:example] is the recommended way of getting Starting from the [example][plugin:example] is the recommended way of getting
started with the plugin. started with the plugin.
[plugin:example]: https://github.com/keyboardio/Akela-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino [plugin:example]: https://github.com/keyboardio/Kaleidoscope-ShapeShifter/blob/master/examples/ShapeShifter/ShapeShifter.ino

@ -1,5 +1,5 @@
/* -*- mode: c++ -*- /* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice
* Copyright (C) 2016, 2017 Gergely Nagy * Copyright (C) 2016, 2017 Gergely Nagy
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
@ -16,7 +16,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
#include <Akela-ShapeShifter.h> #include <Kaleidoscope.h>
#include <Kaleidoscope-ShapeShifter.h>
const Key keymaps[][ROWS][COLS] PROGMEM = { const Key keymaps[][ROWS][COLS] PROGMEM = {
[0] = KEYMAP_STACKED [0] = KEYMAP_STACKED
@ -39,7 +40,7 @@ const Key keymaps[][ROWS][COLS] PROGMEM = {
), ),
}; };
static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = { static const KaleidoscopePlugins::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM = {
{Key_1, Key_2}, {Key_1, Key_2},
{Key_2, Key_1}, {Key_2, Key_1},
{Key_NoKey, Key_NoKey}, {Key_NoKey, Key_NoKey},
@ -48,10 +49,10 @@ static const Akela::ShapeShifter::dictionary_t shapeShiftDictionary[] PROGMEM =
void setup () { void setup () {
ShapeShifter.configure (shapeShiftDictionary); ShapeShifter.configure (shapeShiftDictionary);
Keyboardio.setup (KEYMAP_SIZE); Kaleidoscope.setup (KEYMAP_SIZE);
Keyboardio.use (&ShapeShifter, NULL); Kaleidoscope.use (&ShapeShifter, NULL);
} }
void loop () { void loop () {
Keyboardio.loop (); Kaleidoscope.loop ();
} }

@ -1,10 +1,10 @@
name=Akela-ShapeShifter name=Kaleidoscope-ShapeShifter
version=0.0.0 version=0.0.0
author=Gergely Nagy author=Gergely Nagy
maintainer=Gergely Nagy <akela@gergo.csillger.hu> maintainer=Gergely Nagy <kaleidoscope@gergo.csillger.hu>
sentence=Change the shifted symbols on any key of your choice. sentence=Change the shifted symbols on any key of your choice.
paragraph=Make it possible to send a different keycode when a key is being shifted. paragraph=Make it possible to send a different keycode when a key is being shifted.
category=Communication category=Communication
url=https://github.com/keyboardio/Akela-ShapeShifter url=https://github.com/keyboardio/Kaleidoscope-ShapeShifter
architectures=avr architectures=avr
dot_a_linkage=true dot_a_linkage=true

@ -1,5 +1,5 @@
/* -*- mode: c++ -*- /* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice
* Copyright (C) 2016, 2017 Gergely Nagy * Copyright (C) 2016, 2017 Gergely Nagy
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
@ -18,4 +18,4 @@
#pragma once #pragma once
#include <Akela/ShapeShifter.h> #include <Kaleidoscope/ShapeShifter.h>

@ -1,5 +1,5 @@
/* -*- mode: c++ -*- /* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice
* Copyright (C) 2016, 2017 Gergely Nagy * Copyright (C) 2016, 2017 Gergely Nagy
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
@ -16,9 +16,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/ */
#include <Akela-ShapeShifter.h> #include <Kaleidoscope-ShapeShifter.h>
namespace Akela { namespace KaleidoscopePlugins {
const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL; const ShapeShifter::dictionary_t *ShapeShifter::dictionary = NULL;
bool ShapeShifter::modActive; bool ShapeShifter::modActive;
@ -99,4 +99,4 @@ namespace Akela {
}; };
Akela::ShapeShifter ShapeShifter; KaleidoscopePlugins::ShapeShifter ShapeShifter;

@ -1,5 +1,5 @@
/* -*- mode: c++ -*- /* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything * Kaleidoscope-ShapeShifter -- Change the shifted symbols on any key of your choice
* Copyright (C) 2016, 2017 Gergely Nagy * Copyright (C) 2016, 2017 Gergely Nagy
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
@ -18,10 +18,10 @@
#pragma once #pragma once
#include <Akela-Core.h> #include <Kaleidoscope.h>
namespace Akela { namespace KaleidoscopePlugins {
class ShapeShifter : public KeyboardioPlugin { class ShapeShifter : public KaleidoscopePlugin {
public: public:
typedef struct { typedef struct {
Key original, replacement; Key original, replacement;
@ -48,4 +48,4 @@ namespace Akela {
}; };
}; };
extern Akela::ShapeShifter ShapeShifter; extern KaleidoscopePlugins::ShapeShifter ShapeShifter;
Loading…
Cancel
Save