Skip to content

Commit 6949753

Browse files
docs: report project status as unmaintained (#1134)
* docs: report project status as unmaintained * fix spelling: scanners.md --------- Co-authored-by: regicidal.plutophage <36969337+regicidalplutophage@users.noreply.github.com>
1 parent 39ceff4 commit 6949753

2 files changed

Lines changed: 11 additions & 4 deletions

File tree

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,13 @@ KMK is a feature-rich and beginner-friendly firmware for computer keyboards
99
written and configured in
1010
[CircuitPython](https://github.com/adafruit/circuitpython).
1111

12+
## Status
13+
14+
KMK is no longer actively maintained and on limited life support.
15+
Issues and pull requests will not be addressed for the time being.
16+
Volunteers for taking on the project can voice their interest in the
17+
[Zulip Chat](https://kmkfw.zulipchat.com).
18+
1219
## Support
1320

1421
For asynchronous support and chatter about KMK, [join our Zulip

docs/en/scanners.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ class MyKeyboard(KMKKeyboard):
184184
]
185185
```
186186

187-
If your design requires symetrical encoders (e.g. one on each half of a split keyboard), see Multiple Scanners section below for more details.
187+
If your design requires symmetrical encoders (e.g. one on each half of a split keyboard), see Multiple Scanners section below for more details.
188188

189189

190190
## `Scanner` base class
@@ -223,7 +223,7 @@ class MyKeyboard(KMKKeyboard):
223223

224224
#### Adding Single-Pin Buttons or Rotary Encoders to Keymap Using Scanners and Split
225225

226-
In many cases, split keybaords are symetrical in form and function. Some split keyboards also have additional hardware like one or more rotary encoders, or non-matrix-connected media or macro buttons. In this case, you will want to configure multiple scanners.
226+
In many cases, split keyboards are symmetrical in form and function. Some split keyboards also have additional hardware like one or more rotary encoders, or non-matrix-connected media or macro buttons. In this case, you will want to configure multiple scanners.
227227

228228
The `Split` class that you're probably already using creates the `coord_mapping` indexes automatically. However, the `add_buttons` argument will cause it to append any additional "buttons" (or encoder actions) to the `coord_mapping` for _each half_ of the keyboard.
229229

@@ -271,7 +271,7 @@ if __name__ == '__main__':
271271

272272
#### Multiple Scanners `coord_mapping` and keymap changes
273273
For a more manually-controlled configuration, you can add any other scanners that you need and create your `coord_mapping` in your own code (leaving off the `add_buttons` argument when initializing `Split`)
274-
Creating and assigning a custom `coord_mapping` should be done before intitializing `Split` or any scanners.
274+
Creating and assigning a custom `coord_mapping` should be done before initializing `Split` or any scanners.
275275

276276
The below examples illustrate how the additional encoder actions are assigned to the `coord_mapping`. Your configuration should follow this pattern.
277277

@@ -309,4 +309,4 @@ Notice that, despite the visual layout, all of the encoder keys are at the **_en
309309
Therefore, 4 more key codes can be added in the corresponding places in the `keyboard.keymap`, and they will be assigned to the encoders' actions.
310310

311311

312-
Also note, it may be necessary to configure `Split().split_offset` when configuring your own `coord_mapping` to make sure that the encoders are assigned properly. The value will usually be the first/lowest index value of the right side. In the case of the second example above, the offset value would be 32, but this also depends on your `coord_mapping` layout.
312+
Also note, it may be necessary to configure `Split().split_offset` when configuring your own `coord_mapping` to make sure that the encoders are assigned properly. The value will usually be the first/lowest index value of the right side. In the case of the second example above, the offset value would be 32, but this also depends on your `coord_mapping` layout.

0 commit comments

Comments
 (0)