diff options
| author | Pete Johanson <peter@peterjohanson.com> | 2020-05-26 11:55:58 -0400 |
|---|---|---|
| committer | Pete Johanson <peter@peterjohanson.com> | 2020-05-26 11:55:58 -0400 |
| commit | dfd5bc0586b6201d7fef279b0cc6248fd5a3558c (patch) | |
| tree | 7226fab1cd504b43f51ac828de56b744d7d489f4 | |
| parent | 2ec5be9f8fced3d4f2bde53dc07ddebbbad370ae (diff) | |
More complete intro to the project.
| -rw-r--r-- | docs/docs/intro.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/docs/intro.md b/docs/docs/intro.md index ef330ed..4447af9 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -7,4 +7,27 @@ sidebar_label: Introduction ZMK Firmware is an open source (Apache 2.0) keyboard firmware built on the [Zephyr Project](https://zephyrproject.com/) RTOS. +The goal is to provider a powerful, featureful keyboard firmware that is free +of licensing issues that prevent upstream bluetooth support as a first-class +feature. +## Features + +At this point, ZMK is _missing_ more features than it has. Currently, the mostly working bits +include: + +- HID Over GATT (HOG) - This is the official term for Bluetooth Low Energy HID devices. +- Keymaps and layers with basic keycodes. +- Somem initial work on one "action", Mod-Tap. +- Basic HID over USB - This somehow _conflicts_ with BLE at least on the stm32wb55rg dev kit, so investigation needed. + +## Missing Features + +- Consumer Key Support (play/pause, etc) +- One Shot +- Layer Tap +- Split support +- Encoders +- Battery reporting +- Low power mode. +- Shell over BLE |