my fork of the ZMK keyboard firmware for a Nice!Nano v2 based https://68keys.io/ build
Go to file
Pete Johanson 3d221053da Initial code of conduct documentation. 2020-06-10 21:11:49 -04:00
.github/workflows Name the whole workflow. 2020-06-08 22:48:25 -04:00
.vscode Refactor build/config/keymaps. 2020-05-18 09:11:46 -04:00
app Fix remaining Apache header lines. 2020-06-09 09:54:13 -04:00
docs Initial code of conduct documentation. 2020-06-10 21:11:49 -04:00
.gitlab-ci.yml Small tweak. 2020-05-11 13:58:10 -04:00
CODE_OF_CONDUCT.md Initial code of conduct documentation. 2020-06-10 21:11:49 -04:00
Dockerfile Remove locale tweaks. 2020-05-11 11:24:03 -04:00
LICENSE Add LICENSE 2020-05-01 19:04:48 +00:00
README.md Typo fix, add ™ properly. 2020-06-09 17:00:22 -04:00

README.md

Zephyr™ Mechanical Keyboard (ZMK) Firmware

Build

Netlify Status

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

Basic WIP website to learn more: https://zmk.netlify.app/

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?
  • Split support
    • custom kscan driver? that recieves events from other side over BLE notifications?
    • Need to figure out how to do "custom" GATT services. Custom UUID?
    • Do we need to send any state updates over from primary to secondary side?
  • Encoders
  • Battery reporting.
  • Low power mode, with wakeup from interrupt?
  • Better keymaps to avoid needing extra KC_NO for locations in the matrix that don't even exist!

Long Term

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