diff options
| author | Tsquash <caleblightfoot05@gmail.com> | 2020-10-08 20:40:28 -0500 |
|---|---|---|
| committer | Caleb Lightfoot <caleblightfoot05@gmail.com> | 2020-10-10 22:17:52 -0500 |
| commit | 23e9cbcaf9b00c87953a4a8b4e953ced154e1e4b (patch) | |
| tree | 4045a27f9bd3bf948d283d87203792755f424e30 | |
| parent | e1dcf1514fe2abb22c3569036af2438709c3d4cb (diff) | |
Added Table and fixed Feature sentence
added feature table
new feature sentence
| -rw-r--r-- | docs/docs/intro.md | 49 |
1 files changed, 24 insertions, 25 deletions
diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 8c1c043..02a93e0 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -13,31 +13,30 @@ feature. ## Features -At this point, ZMK is still missing many features. Currently, the working bits -include: - -- Wireless connectivity via BLE HID Over GATT (HOG) -- USB connectivity -- 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) -- [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) -- [Encoders](feature/encoders) -- Basic [OLED display support](feature/displays) -- [RGB Underglow](feature/underglow) - -## Missing Features - -- One Shot Keys -- Combo keys -- Macros -- Complete split support (encoders and RGB are not supported on the 'peripheral' side) -- Battery reporting -- Low power sleep states -- Low power mode (to toggle LEDs and screen off) -- Shell over BLE +At this point, ZMK is still missing many features compared to more developed firmwares such as QMK. Here is a table comparing supported ZMK and QMK features: + +| | ZMK | QMK | +|----------------------------------------------------------------------------------------------------------|:---------:|:-----------:| +| Wireless Connectivity via BLE | ✅ | | +| USB Connectivity | ✅ | ✅ | +| 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) | ✅ | ✅ | +| [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | +| [Encoders](feature/encoders) | ✅ | ✅ | +| Basic [OLED display support](feature/displays) | ✅ | ✅ | +| [RGB Underglow](feature/underglow) | ✅ | ✅ | +| One Shot Keys | | ✅ | +| Combo Keys | | ✅ | +| Macros | | ✅ | +| Mouse Keys | | ✅ | +| Battery Reporting | | | +| Low Power Sleep States | | | +| Low Power Mode (VCC Shutoff) | | | +| Shell over BLE | | | +| AVR/8 Bit | | ✅ | ## Code Of Conduct |