zephyr mechanical keyboard (custom firmware) forked from https://github.com/zmkfirmware/zmk

Go to file

Pete Johanson 03ddcf0695 Properly name the build artifacts w/ shield name.		2020-06-30 12:24:26 -04:00
.github/workflows	Properly name the build artifacts w/ shield name.	2020-06-30 12:24:26 -04:00
.vscode	…
app	Kyria left/right overlays, matrix transform fixes	2020-06-27 00:16:15 -04:00
docs	Add Algolia search config.	2020-06-29 10:20:07 -04:00
.gitignore	Fix .gitignore, add missing changes.	2020-06-24 10:37:02 -04:00
.gitlab-ci.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
LICENSE	…
README.md	…

README.md

Zephyr™ Mechanical Keyboard (ZMK) Firmware

This project is a complete work in progress, with absolutely nothing functioning yet. The goal is to explore a new MK firmware with a less restritive license and better BLE support, built on top of the Zephyr™ Project

Check out the website to learn more: https://zmkfirmware.dev/

TODO

Document boards/shields/keymaps usage.
Display support, including displaying BLE SC auth numbers for "numeric comparison" mode if we have the screen.
Fix BT settings to work w/ Zephyr. Do we really need them?
Tests

Missing Features

Layer Tap
One Shot
Combos
Tap Dance
Shell over BLE/USB
Split support
Encoders
Battery reporting.
Low power mode, with wakeup from interrupt(s)

Long Term

Tool to convert keymap info.json files into a DTS keymap file?
Firmware build service?