pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added Table and fixed Feature sentence

Browse source 
added feature table

new feature sentence
This commit is contained in:
Tsquash 2020-10-08 20:40:28 -05:00 committed by Caleb Lightfoot
parent e1dcf1514f
commit 23e9cbcaf9
1 changed files with 24 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
docs/docs/intro.md
View file

@ -13,31 +13,30 @@ feature.
## Features ## Features
At this point, ZMK is still missing many features. Currently, the working bits 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:
include:
- Wireless connectivity via BLE HID Over GATT (HOG) | | ZMK | QMK |
- USB connectivity |----------------------------------------------------------------------------------------------------------|:---------:|:-----------:|
- Low active power usage | Wireless Connectivity via BLE | ✅ | |
- Split keyboard support | USB Connectivity | ✅ | ✅ |
- [Keymaps and layers](behavior/layers) | Low Active Power Usage | ✅ | |
- [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers)) | Split Keyboard Support | ✅ | ✅ |
- [Basic HID over USB](behavior/key-press) | [Keymaps and Layers](behavior/layers) | ✅ | ✅ |
- [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) | [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers)) | ✅ | ✅ |
- [Encoders](feature/encoders) | [Basic HID over USB](behavior/key-press) | ✅ | ✅ |
- Basic [OLED display support](feature/displays) | [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ |
- [RGB Underglow](feature/underglow) | [Encoders](feature/encoders) | ✅ | ✅ |
| Basic [OLED display support](feature/displays) | ✅ | ✅ |
## Missing Features | [RGB Underglow](feature/underglow) | ✅ | ✅ |
| One Shot Keys | | ✅ |
- One Shot Keys | Combo Keys | | ✅ |
- Combo keys | Macros | | ✅ |
- Macros | Mouse Keys | | ✅ |
- Complete split support (encoders and RGB are not supported on the 'peripheral' side) | Battery Reporting | | |
- Battery reporting | Low Power Sleep States | | |
- Low power sleep states | Low Power Mode (VCC Shutoff) | | |
- Low power mode (to toggle LEDs and screen off) | Shell over BLE | | |
- Shell over BLE | AVR/8 Bit | | ✅ |
## Code Of Conduct ## Code Of Conduct