The Big Rename

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

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

@ -1,4 +1,4 @@
# Akela-Leader
# Kaleidoscope-Leader
![status][st:stable]
@ -34,7 +34,8 @@ create a dictionary, and configure the provided `Leader` object to use the
dictionary:
```c++
#include <Akela-Leader.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-Leader.h>
static void leaderA (void) {
Serial.println ("leaderA");
@ -44,7 +45,7 @@ static void leaderTX (void) {
Serial.println ("leaderTX");
}
static const Akela::Leader::dictionary_t leaderDictionary PROGMEM = LEADER_DICT
static const KaleidoscopePlugins::Leader::dictionary_t leaderDictionary PROGMEM = LEADER_DICT
(
{LEADER_SEQ (LEAD (0), Key_A), leaderA},
{LEADER_SEQ (LEAD (0), Key_T, Key_X), leaderTX}
@ -55,8 +56,8 @@ void setup () {
Leader.configure (leaderDictionary);
Keyboardio.setup (KEYMAP_SIZE);
Keyboardio.use (&Leader, NULL);
Kaleidoscope.setup (KEYMAP_SIZE);
Kaleidoscope.use (&Leader, NULL);
}
```
@ -74,7 +75,7 @@ The plugin provides the `Leader` object, with the following methods:
### `.configure(dictionary)`
> Tells `Leader` to use the specified dictionary. The dictionary is an array of
> `Akela::Leader::dictionary_t` elements. Each element is made up of two
> `Kaleidoscope::Leader::dictionary_t` elements. Each element is made up of two
> elements, the first being a list of keys, the second an action to perform when
> the sequence is found.
@ -99,4 +100,4 @@ The plugin provides the `Leader` 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-Leader/blob/master/examples/Leader/Leader.ino
[plugin:example]: https://github.com/keyboardio/Kaleidoscope-Leader/blob/master/examples/Leader/Leader.ino

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-Leader -- VIM-style leader keys
* 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-Leader.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-Leader.h>
const Key keymaps[][ROWS][COLS] PROGMEM = {
[0] = KEYMAP_STACKED
@ -47,7 +48,7 @@ static void leaderTestAA (uint8_t seqIndex) {
Serial.println (F("leaderTestAA"));
}
static const Akela::Leader::dictionary_t leaderDictionary[] PROGMEM = LEADER_DICT
static const KaleidoscopePlugins::Leader::dictionary_t leaderDictionary[] PROGMEM = LEADER_DICT
(
{LEADER_SEQ(LEAD(0), Key_A), leaderTestA},
{LEADER_SEQ(LEAD(0), Key_A, Key_A), leaderTestAA}
@ -58,10 +59,10 @@ void setup () {
Leader.configure (leaderDictionary);
Keyboardio.setup (KEYMAP_SIZE);
Keyboardio.use (&Leader, NULL);
Kaleidoscope.setup (KEYMAP_SIZE);
Kaleidoscope.use (&Leader, NULL);
}
void loop () {
Keyboardio.loop ();
Kaleidoscope.loop ();
}

@ -1,10 +1,10 @@
name=Akela-Leader
name=Kaleidoscope-Leader
version=0.0.0
author=Gergely Nagy
maintainer=Gergely Nagy <akela@gergo.csillger.hu>
sentence=Leader keys for Keyboardio boards.
maintainer=Gergely Nagy <kaleidoscope@gergo.csillger.hu>
sentence=Leader keys for Kaleidoscope.
paragraph=VIM-style leader keys.
category=Communication
url=https://github.com/keyboardio/Akela-Leader
url=https://github.com/keyboardio/Kaleidoscope-Leader
architectures=avr
dot_a_linkage=true

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-Leader -- VIM-style leader keys
* 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/Leader.h>
#include <Kaleidoscope/Leader.h>

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-Leader -- VIM-style leader keys
* 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-Leader.h>
#include <Kaleidoscope-Leader.h>
using namespace Akela::Ranges;
using namespace KaleidoscopePlugins::Ranges;
namespace Akela {
namespace KaleidoscopePlugins {
// --- state ---
Key Leader::sequence[LEADER_MAX_SEQUENCE_LENGTH + 1];
uint8_t Leader::sequencePos;
@ -175,4 +175,4 @@ namespace Akela {
}
};
Akela::Leader Leader;
KaleidoscopePlugins::Leader Leader;

@ -1,5 +1,5 @@
/* -*- mode: c++ -*-
* Akela -- Animated Keyboardio Extension Library for Anything
* Kaleidoscope-Leader -- VIM-style leader keys
* Copyright (C) 2016, 2017 Gergely Nagy
*
* This program is free software: you can redistribute it and/or modify
@ -18,17 +18,18 @@
#pragma once
#include <Akela-Core.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-Ranges.h>
#define LEADER_MAX_SEQUENCE_LENGTH 16
#define LEAD(n) (Key){ .raw = Akela::Ranges::LEAD_FIRST + n }
#define LEAD(n) (Key){ .raw = KaleidoscopePlugins::Ranges::LEAD_FIRST + n }
#define LEADER_SEQ(...) { __VA_ARGS__, Key_NoKey }
#define LEADER_DICT(...) { __VA_ARGS__, {{Key_NoKey}, NULL} }
namespace Akela {
class Leader : public KeyboardioPlugin {
namespace KaleidoscopePlugins {
class Leader : public KaleidoscopePlugin {
public:
typedef void (*action_t) (uint8_t seqIndex);
typedef struct {
@ -58,4 +59,4 @@ namespace Akela {
};
};
extern Akela::Leader Leader;
extern KaleidoscopePlugins::Leader Leader;
Loading…
Cancel
Save