sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add more warning labels

Browse Source
This commit is contained in:
xs5871 2022-08-18 20:03:30 +00:00 committed by Kyle Brown
parent 46cf7030a1
commit a4ae43138a
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@ -29,7 +29,7 @@
- [Mouse keys](mouse_keys.md): Adds mouse keycodes - [Mouse keys](mouse_keys.md): Adds mouse keycodes
- [OneShot](oneshot.md): Adds support for oneshot/sticky keys. - [OneShot](oneshot.md): Adds support for oneshot/sticky keys.
- [Power](power.md): Power saving features. This is mostly useful when on battery power. - [Power](power.md): Power saving features. This is mostly useful when on battery power.
- [SerialACE](serialace.md): Arbitrary Code Execution over the data serial. - [SerialACE](serialace.md): [DANGER - _see module README_] Arbitrary Code Execution over the data serial.
- [Split](split_keyboards.md): Keyboards split in two. Seems ergonomic! - [Split](split_keyboards.md): Keyboards split in two. Seems ergonomic!
- [TapDance](tapdance.md): Different key actions depending on how often it is pressed. - [TapDance](tapdance.md): Different key actions depending on how often it is pressed.

2
docs/modules.md
View File

@ -16,7 +16,7 @@ when tapped, and modifier when held.
- [OneShot](oneshot.md): Adds support for oneshot/sticky keys. - [OneShot](oneshot.md): Adds support for oneshot/sticky keys.
- [Power](power.md): Power saving features. This is mostly useful when on battery power. - [Power](power.md): Power saving features. This is mostly useful when on battery power.
- [Split](split_keyboards.md): Keyboards split in two. Seems ergonomic! - [Split](split_keyboards.md): Keyboards split in two. Seems ergonomic!
- [SerialACE](serialace.md): Arbitrary Code Execution over the data serial. - [SerialACE](serialace.md): [DANGER - _see module README_] Arbitrary Code Execution over the data serial.
- [TapDance](tapdance.md): Different key actions depending on how often it is pressed. - [TapDance](tapdance.md): Different key actions depending on how often it is pressed.
- [Dynamic Sequences](dynamic_sequences.md): Records a sequence of keypresses and plays it back. - [Dynamic Sequences](dynamic_sequences.md): Records a sequence of keypresses and plays it back.

14
docs/serialace.md
View File

@ -1,12 +1,12 @@
# Serial ACE (Arbitrary Code Execution over serial interface) # Serial ACE (Arbitrary Code Execution over serial interface)
> Caution: This module allows unrestricted, arbitrary code execution on your KMK **Caution: This module allows unrestricted, arbitrary code execution on your KMK
> device. That includes potential exploits, such as keyloggers, and unvetted device. That includes potential exploits, such as keyloggers, and unvetted
> user code that may result in undesired behaviour and/or crashes. user code that may result in undesired behaviour and/or crashes.
> This feature is purely experimental in the sense that you probably neither This feature is purely experimental in the sense that you probably neither
> want nor should use it in production. want nor should use it in production.
> Advanced knowledge of python and the serial console is required, and we will Advanced knowledge of python and the serial console is required, and we will
> not provide help or support in any way. not provide help or support in any way.**
This module provides an API to run any valid python code on your keyboard and This module provides an API to run any valid python code on your keyboard and
return the result of that code via an additional serial consol (not the one you return the result of that code via an additional serial consol (not the one you