pwarren/zmk_mf68
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
my fork of the ZMK keyboard firmware for a Nice!Nano v2 based https://68keys.io/ build
212 commits 1 branch 0 tags 16 MiB
C 96.9%
CMake 2.5%
Python 0.4%
Shell 0.2%
Find a file
Pete Johanson 17ef033f00 Tweaks to readme.
2020-06-24 10:19:02 -04:00
.github/workflows Tweak the artifact name to include board. 2020-06-16 23:03:15 -04:00
.vscode Configure .overlay files to use dts file assocation. 2020-06-15 06:26:38 -04:00
app Tweaks to readme. 2020-06-24 10:19:02 -04:00
docs A few more master to main fixes. 2020-06-17 10:38:15 -04:00
.gitignore Minor build fixes for VSCode, extra ignore. 2020-06-14 23:56:10 -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 Updated copyright line. 2020-06-22 05:47:20 -04:00
README.md Minor cleanup of the toplevel README. 2020-06-17 10:41:49 -04:00

README.md

Zephyr™ Mechanical Keyboard (ZMK) Firmware

Build Contributor Covenant

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?