The Big Rename

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

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

@ -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 <Akela-Unicode.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-Unicode.h>
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

@ -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 <http://www.gnu.org/licenses/>.
*/
#define AKELA_HOSTOS_GUESSER 1
#define KALEIDOSCOPE_HOSTOS_GUESSER 1
#include <Akela-Unicode.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-Unicode.h>
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 ();
}

@ -1,10 +1,10 @@
name=Akela-Unicode
name=Kaleidoscope-Unicode
version=0.0.0
author=Gergely Nagy
maintainer=Gergely Nagy <akela@gergo.csillger.hu>
sentence=Unicode input helpers for Keyboardio boards.
maintainer=Gergely Nagy <kaleidoscope@gergo.csillger.hu>
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

@ -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 <Akela/Unicode.h>
#include <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
@ -16,9 +16,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include <Akela-Unicode.h>
#include <Kaleidoscope-Unicode.h>
namespace Akela {
namespace KaleidoscopePlugins {
Unicode::Unicode (void) {
}
@ -175,4 +175,4 @@ void
unicodeCustomInput (void) {
}
Akela::Unicode Unicode;
KaleidoscopePlugins::Unicode Unicode;

@ -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 <Akela-Core.h>
#include <Akela-HostOS.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-HostOS.h>
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;
Loading…
Cancel
Save