diff options
| author | Caleb Lightfoot <caleblightfoot05@gmail.com> | 2020-10-10 22:40:14 -0500 |
|---|---|---|
| committer | Caleb Lightfoot <caleblightfoot05@gmail.com> | 2020-10-10 22:40:14 -0500 |
| commit | 593d7ff7812f2ec66d3bbafd577205137c59879f (patch) | |
| tree | 4363e7589022c92d06b50c4b402882fe36f33b1d | |
| parent | 56ab812a6764d6ba0471f41e2806d3a7d076b8c8 (diff) | |
made table completely visual; changed feature sentence
| -rw-r--r-- | docs/docs/intro.md | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/docs/docs/intro.md b/docs/docs/intro.md index ab21138..c5a214d 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -9,7 +9,8 @@ firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time ## Features -At this point, ZMK is still missing many features compared to popular firmware such as QMK. Here is a table comparing supported ZMK, BlueMicro, and QMK features: +ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK: + | **Feature** | ZMK | BlueMicro | QMK | |--------------------------------------------------------------------------------------------------------|:-----------:|:------------:|:-----------:| @@ -19,24 +20,24 @@ At this point, ZMK is still missing many features compared to popular firmware s | User Configuration Repositories | ✅ | | | | Split Keyboard Support | ✅ | ✅ | ✅ | | [Keymaps and Layers](behavior/layers) | ✅ | ✅ | ✅ | -| [Hold-Tap](behavior/hold-tap) (Which Includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ | +| [Hold-Tap](behavior/hold-tap) (which includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ | | [Basic Keycodes](behavior/key-press) | ✅ | ✅ | ✅ | | [Basic consumer (Media) Keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | ✅ | | [Encoders](feature/encoders)[^1] | ✅ | | ✅ | -| [OLED Display Support](feature/displays)[^2] | In Dev | In Dev | ✅ | +| [OLED Display Support](feature/displays)[^2] | 🚧 | 🚧 | ✅ | | [RGB Underglow](feature/underglow) | ✅ | ✅ | ✅ | -| One Shot Keys | In Dev | ✅ | ✅ | -| Combo Keys | In Dev | | ✅ | -| Macros | In Dev | ✅ | ✅ | +| One Shot Keys | 🚧 | ✅ | ✅ | +| Combo Keys | 🚧 | | ✅ | +| Macros | 🚧 | ✅ | ✅ | | Mouse Keys | | ✅ | ✅ | | Low Active Power Usage | ✅ | | | -| Low Power Sleep States | In Dev | ✅ | | -| Low Power Mode (VCC Shutoff) | In Dev | | | -| Battery Reporting | In Dev | ✅ | | -| Shell over BLE | | | | -| Realtime Keymap Updating | Planned | | ✅ | -| AVR/8 Bit | | | ✅ | -| Wide Range of ARM Chips Supported | ✅ | | | +| Low Power Sleep States | 🚧 | ✅ | | +| Low Power Mode (VCC Shutoff) | 🚧 | | | +| Battery Reporting | 🚧 | ✅ | | +| Shell over BLE | | | | +| Realtime Keymap Updating | 💡 | | ✅ | +| AVR/8 Bit | | | ✅ | +| Wide Range of ARM Chips Supported | ✅ | | | [^2]: Encoders are not currently supported on peripheral side splits. [^1]: OLEDs are currently proof of concept in ZMK. |