Pete Johanson 03ddcf0695 Properly name the build artifacts w/ shield name.		4 years ago
.github/workflows	Properly name the build artifacts w/ shield name.	4 years ago
.vscode	Configure .overlay files to use dts file assocation.	5 years ago
app	Kyria left/right overlays, matrix transform fixes	4 years ago
docs	Add Algolia search config.	4 years ago
.gitignore	Fix .gitignore, add missing changes.	4 years ago
.gitlab-ci.yml	Small tweak.	5 years ago
CODE_OF_CONDUCT.md	Initial code of conduct documentation.	5 years ago
Dockerfile	Remove locale tweaks.	5 years ago
LICENSE	Updated copyright line.	4 years ago
README.md	Minor cleanup of the toplevel README.	5 years ago

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?