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

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