zmk_mf68/README.md

# Zephyr™ Mechanical Keyboard (ZMK) Firmware

[![Build](https://github.com/zmkfirmware/zmk/workflows/Build/badge.svg)](https://github.com/zmkfirmware/zmk/actions)
[![Netlify Status](https://api.netlify.com/api/v1/badges/942d61a9-87c0-4c23-9b51-f5ed0bce495d/deploy-status)](https://app.netlify.com/sites/zmk/deploys)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)

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](https://www.zephyrproject.org/)

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?
Typo fix, add ™ properly. 2020-06-10 07:00:22 +10:00			`# Zephyr™ Mechanical Keyboard (ZMK) Firmware`
README file. 2020-05-02 06:49:04 +10:00
Make workflow badge link to the GH Actions page. 2020-06-09 12:57:28 +10:00			`[![Build](https://github.com/zmkfirmware/zmk/workflows/Build/badge.svg)](https://github.com/zmkfirmware/zmk/actions)`
Docs deploy badge. 2020-05-26 11:39:44 +10:00			`[![Netlify Status](https://api.netlify.com/api/v1/badges/942d61a9-87c0-4c23-9b51-f5ed0bce495d/deploy-status)](https://app.netlify.com/sites/zmk/deploys)`
Add CoC badge to README.md as well. 2020-06-11 11:18:28 +10:00			`[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](code_of_conduct.md)`
Docs deploy badge. 2020-05-26 11:39:44 +10:00
README file. 2020-05-02 06:49:04 +10:00			`This project is a complete work in progress, with absolutely nothing functioning yet. The goal is to explore a new MK firmware`
Typo fix, add ™ properly. 2020-06-10 07:00:22 +10:00			`with a less restritive license and better BLE support, built on top of the [Zephyr™ Project](https://www.zephyrproject.org/)`
README file. 2020-05-02 06:49:04 +10:00
Add link to WIP website. 2020-05-28 00:42:35 +10:00			`Basic WIP website to learn more: https://zmk.netlify.app/`

Add some TODOs to the toplevel readme. 2020-05-16 11:52:25 +10:00			`## TODO`

Keymap directory support. 2020-05-17 07:30:30 +10:00			`- Document boards/shields/keymaps usage.`
Add some TODOs to the toplevel readme. 2020-05-16 11:52:25 +10:00			`- 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?`

Initial passkey entry support. 2020-05-17 13:26:26 +10:00			`# Missing Features`

Implement a basic set of consumer page keycodes. 2020-06-03 01:23:22 +10:00			`- Layer Tap`
Initial passkey entry support. 2020-05-17 13:26:26 +10:00			`- One Shot`
Add a few more intended features. 2020-06-09 11:04:34 +10:00			`- Combos`
			`- Tap Dance`
Initial passkey entry support. 2020-05-17 13:26:26 +10:00			`- Shell over BLE?`
			`- Split support`
Move BLE passkey entry behind config flag. 2020-05-19 05:07:37 +10:00			`- 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?`
More README updates. 2020-05-19 06:21:41 +10:00			`- Encoders`
A few more readme items. 2020-05-20 05:24:11 +10:00			`- Battery reporting.`
			`- Low power mode, with wakeup from interrupt?`
Note about need for keymaps with no pad at a matrix location. 2020-05-30 01:20:27 +10:00			`- Better keymaps to avoid needing extra KC_NO for locations in the matrix that don't even exist!`
Initial passkey entry support. 2020-05-17 13:26:26 +10:00
Add some TODOs to the toplevel readme. 2020-05-16 11:52:25 +10:00			`## Long Term`

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