mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-19 20:45:18 -05:00

Go to file

Pete Johanson 223edf05ad Refactor global bindings, implement mod-tap.

* Use extra comptible = "zmk,behavior-global" to add
   behaviors to global bindings for event notification.
* Implement mod-tap, as a keymap binding and global one
  to skip tap if other keycode pressed while held.

2020-06-21 21:43:44 -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

Refactor global bindings, implement mod-tap.

2020-06-21 21:43:44 -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

Add LICENSE

2020-05-01 19:04:48 +00:00

README.md

Minor cleanup of the toplevel README.

2020-06-17 10:41:49 -04:00

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?