sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
kmk_firmware/docs/en
History
Phong Le 2ccad46e26
update modtap to holdtap (#718) 
* update modtap to holdtap

* Update links

* Revert "Update links"

This reverts commit 8d0cda7c5a43c84dd18b927cb73672158e4f8abc.

* updated docs links

update links in docs

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* rename modtap.md to holdtap.md

* Update Getting_Started.md

* Update main.py

* Update modtap.py

* Update modtap.py and add notice

* Update docs/en/porting_to_kmk.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/handwiring.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/contributing.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/contributing.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/ble_hid.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/Getting_Started.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Update docs/en/kmkpython_vs_circuitpython.md

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>

* Rename modtap.md to holdtap.md

* fixup

---------

Co-authored-by: xs5871 <60395129+xs5871@users.noreply.github.com>
2023-03-03 09:32:41 +00:00
..
adns9800.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
ble_hid.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
boot.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
capsword.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00: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
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00: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
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
extension_statusled.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
extension_stringy_keymaps.md
Update docs/en/extension_stringy_keymaps.md
2023-02-12 19:45:18 +00:00
extensions.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
flashing.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
Getting_Started.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
handwiring.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
holdtap.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00: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
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
layers.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
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
modules.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
mouse_keys.md
Add mouse buttons 4/5
2023-02-21 00:57:39 +00:00
Officially_Supported_Microcontrollers.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
oneshot.md
Update oneshot.md
2023-02-28 19:36:19 +00:00
peg_oled_display.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
peg_rgb_matrix.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
pimoroni_trackball.md
add trackball rotation to example in docs
2023-01-02 23:02:08 +00:00
pins56.jpg
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
porting_to_kmk.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00:00
power.md
Move docs/ to docs/en/
2022-10-25 01:24:49 -07:00
pro_micro_pinout.png
Moved pro micro image to fix render issues
2023-02-21 01:26:39 +00:00
quickpin.md
Moved pro micro image to fix render issues
2023-02-21 01:26:39 +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
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00: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
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00: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
Replace all mentions of the matrix channel with links to zulip
2023-02-12 17:25:24 +00:00
tapdance.md
update modtap to holdtap (#718)
2023-03-03 09:32:41 +00: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
  • HoldTap: 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