sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
002a57b3b1
kmk_firmware/docs
History
Kyle Brown 002a57b3b1 Replace tabs with spaces
2022-09-20 08:09:04 +00:00
..
ja remove reference to disfunct KMK_RELEASE. 2022-08-03 20:11:00 +00:00
ptBR docs(sequences): clarity in keymap arrays to not look like splats (resolves #576) 2022-09-07 19:02:34 -07:00
adns9800.md add backtick quotes for code snippets 2022-04-25 16:53:22 +00:00
ble_hid.md spelling/capitalization/usage on proper nouns 2022-04-25 16:53:22 +00:00
boot.md spelling/capitalization/usage on proper nouns 2022-04-25 16:53:22 +00:00
capsword.md Capitalize Python class names 2022-04-25 16:53:22 +00:00
cg_swap.md fix import typo in cg_swap.md 2022-09-14 03:41:43 +00:00
combos.md Add key coord combos 2022-09-20 08:04:57 +00:00
config_and_keymap.md Fixed missing closing bracket 2022-06-22 14:20:19 +00:00
contributing.md spelling/capitalization/usage on proper nouns 2022-04-25 16:53:22 +00:00
debugging.md feat(extensions): most of the extensions implementation, by kdb424 2021-06-20 13:55:16 -07:00
dynamic_sequences.md Improved readability and finished renaming 2022-05-19 15:10:32 +00:00
easypoint.md fix typo in code example in easypoint docs 2022-06-05 20:22:31 +00:00
encoder.md Rename encoder resolution to divisor 2022-07-08 11:03:01 +00:00
extension_statusled.md Correct spelling of common words in .md files 2022-04-25 16:53:22 +00:00
extension_stringy_keymaps.md Conform class name case conventions 2022-05-08 20:10:41 +00:00
extensions.md Conform class name case conventions 2022-05-08 20:10:41 +00:00
flashing.md spelling/capitalization/usage on proper nouns 2022-04-25 16:53:22 +00:00
Getting_Started.md remove reference to disfunct KMK_RELEASE. 2022-08-03 20:11:00 +00:00
handwiring.md chore: Fix URL and added a space for cleaner look 2021-08-23 23:06:04 -07:00
international.md docs and typos 2021-06-25 10:53:58 -07:00
keycodes.md fix typo and formatting again 2022-07-19 16:16:47 -07:00
keys.md Changed links to relative filepath links 2022-05-20 12:29:37 -07:00
kmkpython_vs_circuitpython.md spelling/capitalization/usage on proper nouns 2022-04-25 16:53:22 +00:00
layers.md changes per https://github.com/KMKfw/kmk_firmware/pull/350\#issuecomment-1059061967 2022-03-05 10:40:09 -08:00
led.md Updated docs to match default states in led.py 2022-06-28 08:14:27 -07:00
lock_status.md Update code to be less fragile 2022-08-10 17:12:12 +00:00
media_keys.md add brightness consumer keys 2022-07-14 16:46:21 -07:00
midi.md Fix MIDI PR files 2022-03-06 00:56:05 -08:00
modtap.md add backtick quotes for code snippets 2022-04-25 16:53:22 +00:00
modules.md add more warning labels 2022-08-31 18:25:07 -07:00
mouse_keys.md Improve clarity in mouse_keys.md 2022-06-11 09:10:26 -07:00
Officially_Supported_Microcontrollers.md Reimplemented as a util script with std lib only. 2022-08-31 18:16:49 -07:00
oneshot.md Fix wrong module name used in oneshot.md 2022-06-24 14:12:17 -07:00
peg_oled_display.md I missed a few things in the docs 2022-05-12 21:56:01 +00:00
peg_rgb_matrix.md Updated and linted documentation for peg_rgb_matrix. 2022-09-15 20:24:45 -07:00
pimoroni_trackball.md Update Pimoroni Trackball doc 2022-07-31 07:44:22 +00:00
pins56.jpg cleaner and smaller pins56.jpg 2022-01-02 07:08:22 +00:00
porting_to_kmk.md [doc] add a simple way to make a coord_mapping 2022-06-11 19:27:15 +00:00
power.md spelling/capitalization/usage on proper nouns 2022-04-25 16:53:22 +00:00
rapidfire.md Rename randomize to enable_interval_randomization 2022-06-30 06:37:57 +00:00
README.md add more warning labels 2022-08-31 18:25:07 -07:00
rgb.md bring rgb docs somewhat up-to-date 2022-09-16 17:59:24 -07:00
scanners.md typo? 2022-07-30 08:26:33 +00:00
sequences.md Replace tabs with spaces 2022-09-20 08:09:04 +00:00
serialace.md add more warning labels 2022-08-31 18:25:07 -07:00
split_keyboards.md remove adafruit_pioasm dependency 2022-07-21 18:26:08 -07:00
sticky_mod.md Fix typo in sticky_mod.md 2022-08-05 10:49:23 -07:00
string_substitution.md Rename text_replacement.md to string_substitution.md 2022-07-14 10:29:25 +00:00
support.md remove reference to disfunct KMK_RELEASE. 2022-08-03 20:11:00 +00:00
tapdance.md update tapdance docs 2022-05-06 20:29:26 -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