alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '266d8e658f'
${ noResults }
Kaleidoscope/doc/plugin/LEDControl.md

20 lines
703 B
Raw Normal View History Unescape

Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/LEDControl.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
# Kaleidoscope-LEDControl
This is a plugin for [Kaleidoscope][fw], for controlling the LEDs, and LED
effects.
[fw]: https://github.com/keyboardio/Kaleidoscope
## Upgrading
Further source code rearrangement Moved all files but `LEDControl.c` and `LEDControl.h` to `src/kaleidoscope/plugin/LEDControl`, to not pollute the `kaleidoscope/plugin` directory needlessly, with headers that should not be explicitly included. Also updated the documentation and the warnings emitted to make it clear that the use of `LED-Off.h` and `LEDUtils.h` is deprecated in favour of just using `<Kaleidoscope-LEDControl.h>`. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
The `LEDUtils.h` and `LED-Off.h` headers are now included by default when using
`<Kaleidoscope-LEDControl.h>`, and their explicit use is therefore deprecated.
The includes can be safely removed.
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/LEDControl.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
Further source code rearrangement Moved all files but `LEDControl.c` and `LEDControl.h` to `src/kaleidoscope/plugin/LEDControl`, to not pollute the `kaleidoscope/plugin` directory needlessly, with headers that should not be explicitly included. Also updated the documentation and the warnings emitted to make it clear that the use of `LED-Off.h` and `LEDUtils.h` is deprecated in favour of just using `<Kaleidoscope-LEDControl.h>`. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
Compatibility headers are in place for both, but will be removed by 2019-01-14.
Rearrange the file layout in preparation of becoming a monorepo Move the documentation to `doc/plugin/LEDControl.md`, sources under `src/kaleidoscope/plugin/` (appropriately namespaced). This is in preparation of merging plugins into a single monorepo. Signed-off-by: Gergely Nagy <algernon@keyboard.io>
6 years ago
Furthermore, to implement LED modes, one should use
`kaleidoscope::plugin::LEDMode` as a base class now, instead of the former
`kaleidoscope::LEDMode`. There is a backwards compatible typedef, but like the
headers, it will be removed by 2019-01-14.