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
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