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

Merge pull request #250 from Tsquash/docs

Browse source 
Added Feature Matrix for Intro.md
This commit is contained in:
Pete Johanson 2020-10-15 11:24:15 -04:00 committed by GitHub
commit a1387eb041
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
docs/docs/intro.md
View file

@ -5,39 +5,41 @@ sidebar_label: Introduction
--- ---
ZMK Firmware is an open source (MIT) keyboard ZMK Firmware is an open source (MIT) keyboard
firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time Operating System (RTOS). firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.
The goal is to provide a powerful, featureful keyboard firmware that is free
of licensing issues that prevent upstream BLE support as a first-class
feature.
## Features ## Features
At this point, ZMK is still missing many features. Currently, the working bits ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK:
include:
- Wireless connectivity via BLE HID Over GATT (HOG)
- USB connectivity | **Feature** | ZMK | BlueMicro | QMK |
- Low active power usage |--------------------------------------------------------------------------------------------------------|:-----------:|:------------:|:-----------:|
- Split keyboard support | Low Latency BLE Support | ✅ | ✅ | |
- [Keymaps and layers](behavior/layers) | Multi-Device BLE Support | ✅ | | |
- [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers)) | USB Connectivity | ✅ | | ✅ |
- [Basic HID over USB](behavior/key-press) | User Configuration Repositories | ✅ | | |
- [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) | Split Keyboard Support | ✅ | ✅ | ✅ |
- [Encoders](feature/encoders) | [Keymaps and Layers](behavior/layers) | ✅ | ✅ | ✅ |
- Basic [OLED display support](feature/displays) | [Hold-Tap](behavior/hold-tap) (which includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ |
- [RGB Underglow](feature/underglow) | [Basic Keycodes](behavior/key-press) | ✅ | ✅ | ✅ |
| [Basic consumer (Media) Keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | ✅ |
## Missing Features | [Encoders](feature/encoders)[^1] | ✅ | | ✅ |
| [OLED Display Support](feature/displays)[^2] | 🚧 | 🚧 | ✅ |
- One Shot Keys | [RGB Underglow](feature/underglow) | ✅ | ✅ | ✅ |
- Combo keys | One Shot Keys | 🚧 | ✅ | ✅ |
- Macros | Combo Keys | 🚧 | | ✅ |
- Complete split support (encoders and RGB are not supported on the 'peripheral' side) | Macros | 🚧 | ✅ | ✅ |
- Battery reporting | Mouse Keys | | ✅ | ✅ |
- Low power sleep states | Low Active Power Usage | ✅ | | |
- Low power mode (to toggle LEDs and screen off) | [Low Power Sleep States](https://github.com/zmkfirmware/zmk/pull/211) | 🚧 | ✅ | |
- Shell over BLE | [Low Power Mode (VCC Shutoff)](https://github.com/zmkfirmware/zmk/pull/242) | 🚧 | | |
| [Battery Reporting](https://github.com/zmkfirmware/zmk/issues/47) | 🚧 | ✅ | |
| Shell over BLE | | | |
| Realtime Keymap Updating | 💡 | | ✅ |
| AVR/8 Bit | | | ✅ |
| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | |
[^2]: Encoders are not currently supported on peripheral side splits.
[^1]: OLEDs are currently proof of concept in ZMK.
## Code Of Conduct ## Code Of Conduct