Skip to content

Commit

Permalink
minor doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
patricksurry authored and xs5871 committed Dec 5, 2023
1 parent e7b0c0e commit 4d26513
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
8 changes: 8 additions & 0 deletions docs/en/config_and_keymap.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ print(dir(board))
keyboard.keymap = [[KC.A, KC.B]]
```

- The keymap contains a flat list of `Key` objects for each layer of the keyboard.
The list of keys in each layer are stored as a single list that folllows the
grid of row and column pins in the keyboard matrix. This list starts with keys
in the first row from left to right, then the second row, and so on.
The row x column matrix structure doesn't appear explicitly
in the keymap. Use `KC.NO` to mark grid positions without a physical key.
For very sparse grids `keyboard.coord_mapping` can be useful to avoid `KC.NO`.

You can further define a bunch of other stuff:

- `keyboard.debug_enabled` which will spew a ton of debugging information to the serial
Expand Down
16 changes: 14 additions & 2 deletions docs/en/holdtap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# HoldTap Keycodes
Enabling HoldTap will give you access to the following keycodes and can simply be
added to the modules list.
The HoldTap module lets keys do double duty:
tap the key to do one thing,
hold it longer than the configurable `tap_time` to do another.

HoldTap is often used with modifier keys.
For example `KC.HT(KC.ESCAPE, KC.LCTRL)` configures
a key that sends Escape when tapped and
left control when held.
It can be used with regular keys as well
like `KC.HT(KC.SPACE, KC.ENTER)` to send space on tab
and enter on hold.

Simply import HoldTap and add it to the modules list.
This lets you use `KC.HT` actions like those below.

```python
from kmk.modules.holdtap import HoldTap
Expand Down

0 comments on commit 4d26513

Please sign in to comment.