The Big Rename

Renamed the library to Kaleidoscope-OneShot, and followed up with other renames.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/389/head
Gergely Nagy 8 years ago
parent 4396a9f405
commit 28228d07c7

@ -1,4 +1,4 @@
# Akela-OneShot
# Kaleidoscope-OneShot
![status][st:stable]
@ -29,27 +29,29 @@ There are two major ways in which the plugin can be used: one is to turn
existing modifiers or momentary layer toggles into one-shot keys:
```c++
#include <Akela-OneShot.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-OneShot.h>
void setup () {
OneShot.enableAuto ();
Keyboardio.setup (KEYMAP_SIZE);
Keyboardio.use (&OneShot, NULL);
Kaleidoscope.setup (KEYMAP_SIZE);
Kaleidoscope.use (&OneShot, NULL);
}
```
The other is to explicitly mark keys as one-shot in the keymap:
```c++
#include <Akela-OneShot.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-OneShot.h>
// somewhere in the keymap...
OSM(LCtrl), OSL(_FN)
void setup () {
Keyboardio.setup (KEYMAP_SIZE);
Keyboardio.use (&OneShot, NULL);
Kaleidoscope.setup (KEYMAP_SIZE);
Kaleidoscope.use (&OneShot, NULL);
}
```
@ -68,7 +70,7 @@ There are two macros the plugin provides:
> Takes a layer number as argument, and sets up the key to act as a one-shot
> layer key.
>
> Please note that while `KeyboardioFirmware` supports more, one-shot layers are
> Please note that while `KaleidoscopeFirmware` supports more, one-shot layers are
> limited to 24 layers only.
## Plugin methods
@ -83,7 +85,7 @@ modifiers and one-shot layer keys. It has the following methods:
> injects a modifier or a momentary layer switch key, those will be left alone,
> as-is.
>
> This **must** be called before any `Keyboardio.use()` call in the `setup()`
> This **must** be called before any `Kaleidoscope.use()` call in the `setup()`
> method of your Sketch.
### `.isActive()`
@ -147,4 +149,4 @@ modifiers and one-shot layer keys. It has 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-OneShot/blob/master/examples/OneShot/OneShot.ino
[plugin:example]: https://github.com/keyboardio/Kaleidoscope-OneShot/blob/master/examples/OneShot/OneShot.ino

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-OneShot -- One-shot modifiers and layers
* 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 <http://www.gnu.org/licenses/>.
*/
#include <Akela-OneShot.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-OneShot.h>
const Key keymaps[][ROWS][COLS] PROGMEM = {
[0] = KEYMAP_STACKED
@ -62,10 +63,10 @@ const Key keymaps[][ROWS][COLS] PROGMEM = {
void setup () {
OneShot.enableAuto ();
Keyboardio.use (&OneShot, NULL);
Keyboardio.setup (KEYMAP_SIZE);
Kaleidoscope.use (&OneShot, NULL);
Kaleidoscope.setup (KEYMAP_SIZE);
}
void loop () {
Keyboardio.loop ();
Kaleidoscope.loop ();
}

@ -1,10 +1,10 @@
name=Akela-OneShot
name=Kaleidoscope-OneShot
version=0.0.0
author=Gergely Nagy
maintainer=Gergely Nagy <akela@gergo.csillger.hu>
sentence=One-shot modifiers and layers for Keyboardio boards.
maintainer=Gergely Nagy <kaleidoscope@gergo.csillger.hu>
sentence=One-shot modifiers and layers for Kaleidoscope.
paragraph=Provides a way to use one-shot modifiers and layers.
category=Communication
url=https://github.com/keyboardio/Akela-OneShot
url=https://github.com/keyboardio/Kaleidoscope-OneShot
architectures=avr
dot_a_linkage=true

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-OneShot -- One-shot modifiers and layers
* 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 <Akela/OneShot.h>
#include <Kaleidoscope/OneShot.h>

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-OneShot -- One-shot modifiers and layers
* Copyright (C) 2016, 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 <http://www.gnu.org/licenses/>.
*/
#include <Akela-OneShot.h>
#include <Kaleidoscope-OneShot.h>
using namespace Akela::Ranges;
using namespace KaleidoscopePlugins::Ranges;
namespace Akela {
namespace KaleidoscopePlugins {
// ---- state ---------
uint32_t OneShot::startTime = 0;
@ -338,4 +338,4 @@ namespace Akela {
};
Akela::OneShot OneShot;
KaleidoscopePlugins::OneShot OneShot;

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-OneShot -- One-shot modifiers and layers
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -18,13 +18,14 @@
#pragma once
#include <Akela-Core.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-Ranges.h>
#define OSM(kc) (Key) {.raw = Akela::Ranges::OSM_FIRST + (Key_ ## kc).keyCode - Key_LCtrl.keyCode}
#define OSL(n) (Key) {.raw = Akela::Ranges::OSL_FIRST + n}
#define OSM(kc) (Key) {.raw = KaleidoscopePlugins::Ranges::OSM_FIRST + (Key_ ## kc).keyCode - Key_LCtrl.keyCode}
#define OSL(n) (Key) {.raw = KaleidoscopePlugins::Ranges::OSL_FIRST + n}
namespace Akela {
class OneShot : public KeyboardioPlugin {
namespace KaleidoscopePlugins {
class OneShot : public KaleidoscopePlugin {
public:
OneShot (void);
@ -71,4 +72,4 @@ namespace Akela {
};
};
extern Akela::OneShot OneShot;
extern KaleidoscopePlugins::OneShot OneShot;
Loading…
Cancel
Save