sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kmk_firmware/docs/en
History
P C Sivan Sriman 6b7848ccfb
Update layers.md 
L87 to L90

1)the function declaration was missing the self argument, so added it.

2)i changed the color changing method call to just changing the hue parameter of the rgb object
2022-12-29 18:52:12 +05:30
..
adns9800.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
ble_hid.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
boot.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
capsword.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
cg_swap.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
combos.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
config_and_keymap.md
Get rid of hard reference to https://github.com/KMKfw/kmk_firmware/blob/master/
2022-10-25 01:24:49 -07:00
contributing.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
debugging.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
dynamic_sequences.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
easypoint.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
encoder.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
extension_statusled.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
extension_stringy_keymaps.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
extensions.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
flashing.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
Getting_Started.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
handwiring.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
international.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
keycodes.md
remove not-implemented keycodes from docs
2022-10-27 19:59:29 -07:00
keys.md
Quick fixup links on English documentation
2022-10-25 01:24:49 -07:00
kmkpython_vs_circuitpython.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
layers.md
Update layers.md
2022-12-29 18:52:12 +05:30
led.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
lock_status.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
media_keys.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
midi.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
modtap.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
modules.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
mouse_keys.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
Officially_Supported_Microcontrollers.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
oneshot.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
peg_oled_display.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
peg_rgb_matrix.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
pimoroni_trackball.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
pins56.jpg
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
porting_to_kmk.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
power.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
quickpin.md
Moved quickpin.md from docs to docs/en
2022-12-26 16:32:15 +00:00
rapidfire.md
Get rid of hard reference to https://github.com/KMKfw/kmk_firmware/blob/master/
2022-10-25 01:24:49 -07:00
README.md
Get rid of hard reference to https://github.com/KMKfw/kmk_firmware/blob/master/
2022-10-25 01:24:49 -07:00
rgb.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
scanners.md
Update debounce docs
2022-10-25 01:35:47 -07:00
sequences.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
serialace.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
split_keyboards.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
sticky_mod.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
string_substitution.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
support.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
tapdance.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00

README.md

Documentation index

Before you look further, you probably want to start with our getting started guide

Basics

Advanced

Modules

  • Combos: Adds chords and sequences
  • Layers: Adds layer support (Fn key) to allow many more keys to be put on your keyboard
  • ModTap: Adds support for augmented modifier keys to act as one key when tapped, and modifier when held.
  • Mouse keys: Adds mouse keycodes
  • OneShot: Adds support for oneshot/sticky keys.
  • Power: Power saving features. This is mostly useful when on battery power.
  • SerialACE: [DANGER - see module README] Arbitrary Code Execution over the data serial.
  • Split: Keyboards split in two. Seems ergonomic!
  • TapDance: Different key actions depending on how often it is pressed.

Peripherals

Extensions

  • International: Adds international keycodes
  • LED: Adds backlight support. This is for monocolor backlight, not RGB
  • LockStatus: Exposes host-side locks like caps or num lock.
  • MediaKeys: Adds support for media keys such as volume
  • RGB: RGB lighting for underglow. Will work on most matrix RGB as will be treated the same as underglow.
  • Status LED: Indicates which layer you are on with an array of single leds.

Language versions