diff options
| author | Caleb Lightfoot <61706196+Tsquash@users.noreply.github.com> | 2020-10-09 11:12:10 -0500 |
|---|---|---|
| committer | Caleb Lightfoot <caleblightfoot05@gmail.com> | 2020-10-10 22:18:18 -0500 |
| commit | 910e207dbcc17fc5120b56550270458a29e0663c (patch) | |
| tree | a5b4796b879bb386c84459169f8a8744c4728261 /docs | |
| parent | e740a83d68bfce54e2d0018d10b93c3242b3a9d9 (diff) | |
Update Intro
changed intro wording and link to layer tap
Update intro.md
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/intro.md | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 6279766..8348c54 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -13,32 +13,35 @@ feature. ## Features -At this point, ZMK is still missing many features compared to more developed firmware such as QMK. Here is a table comparing supported ZMK and QMK features: +At this point, ZMK is still missing many features compared to popular firmware such as QMK. Here is a table comparing supported ZMK and QMK features: | **Feature** |   ZMK   |   QMK   | |----------------------------------------------------------------------------------------------------------|:---------:|:-----------:| -| Wireless Connectivity via BLE | ✅ | | +| Multi-Device BLE Support | ✅ | | | USB Connectivity | ✅ | ✅ | -| Low Active Power Usage | ✅ | | +| Low Active Power Usage | ✅ | | | Split Keyboard Support | ✅ | ✅ | | [Keymaps and Layers](behavior/layers) | ✅ | ✅ | -| [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers)) | ✅ | ✅ | -| [Basic HID over USB](behavior/key-press) | ✅ | ✅ | +| [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers/#layer-tap)) | ✅ | ✅ | +| [Basic Keycodes](behavior/key-press) | ✅ | ✅ | | [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | -| [Encoders](feature/encoders) | ✅ | ✅ | -| Basic [OLED display support](feature/displays) | ✅ | ✅ | +| [Encoders](feature/encoders)[^1] | ✅ | ✅ | +| Proof of Concept [OLED display support](feature/displays) | ✅ | ✅ | | [RGB Underglow](feature/underglow) | ✅ | ✅ | | One Shot Keys | In Dev | ✅ | | Combo Keys | In Dev | ✅ | | Macros | In Dev | ✅ | -| Mouse Keys | | ✅ | +| Mouse Keys | | ✅ | | Battery Reporting | In Dev | | -| Low Power Sleep States | In Dev | | +| Low Power Sleep States | In Dev | | | Low Power Mode (VCC Shutoff) | In Dev | | -| Shell over BLE | | | -| Realtime Keymap Updating | In Dev | ✅ | -| AVR/8 Bit | | ✅ | -| Wide Range of ARM Chips Supported | ✅ | | +| Shell over BLE | | | +| Realtime Keymap Updating | Planned | ✅ | +| AVR/8 Bit | | ✅ | +| Wide Range of ARM Chips Supported | ✅ | | +[^1]:Note: Encoders are not currently supported on peripheral side splits. + + ## Code Of Conduct Please note that this project is released with a |