From 23e9cbcaf9b00c87953a4a8b4e953ced154e1e4b Mon Sep 17 00:00:00 2001 From: Tsquash Date: Thu, 8 Oct 2020 20:40:28 -0500 Subject: [PATCH 01/15] Added Table and fixed Feature sentence added feature table new feature sentence --- docs/docs/intro.md | 49 +++++++++++++++++++++++----------------------- 1 file changed, 24 insertions(+), 25 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 8c1c043d..02a93e0c 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -13,31 +13,30 @@ feature. ## Features -At this point, ZMK is still missing many features. Currently, the working bits -include: - -- Wireless connectivity via BLE HID Over GATT (HOG) -- USB connectivity -- Low active power usage -- Split keyboard support -- [Keymaps and layers](behavior/layers) -- [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers)) -- [Basic HID over USB](behavior/key-press) -- [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) -- [Encoders](feature/encoders) -- Basic [OLED display support](feature/displays) -- [RGB Underglow](feature/underglow) - -## Missing Features - -- One Shot Keys -- Combo keys -- Macros -- Complete split support (encoders and RGB are not supported on the 'peripheral' side) -- Battery reporting -- Low power sleep states -- Low power mode (to toggle LEDs and screen off) -- Shell over BLE +At this point, ZMK is still missing many features compared to more developed firmwares such as QMK. Here is a table comparing supported ZMK and QMK features: + +| | ZMK | QMK | +|----------------------------------------------------------------------------------------------------------|:---------:|:-----------:| +| Wireless Connectivity via BLE | ✅ | | +| USB Connectivity | ✅ | ✅ | +| Low Active Power Usage | ✅ | | +| Split Keyboard Support | ✅ | ✅ | +| [Keymaps and Layers](behavior/layers) | ✅ | ✅ | +| [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers)) | ✅ | ✅ | +| [Basic HID over USB](behavior/key-press) | ✅ | ✅ | +| [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | +| [Encoders](feature/encoders) | ✅ | ✅ | +| Basic [OLED display support](feature/displays) | ✅ | ✅ | +| [RGB Underglow](feature/underglow) | ✅ | ✅ | +| One Shot Keys | | ✅ | +| Combo Keys | | ✅ | +| Macros | | ✅ | +| Mouse Keys | | ✅ | +| Battery Reporting | | | +| Low Power Sleep States | | | +| Low Power Mode (VCC Shutoff) | | | +| Shell over BLE | | | +| AVR/8 Bit | | ✅ | ## Code Of Conduct From 90b56a19410302b84aba5b9443f3e2f5b852a380 Mon Sep 17 00:00:00 2001 From: Tsquash Date: Thu, 8 Oct 2020 21:15:50 -0500 Subject: [PATCH 02/15] added in dev --- docs/docs/intro.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 02a93e0c..5d4b50e2 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -13,9 +13,9 @@ feature. ## Features -At this point, ZMK is still missing many features compared to more developed firmwares such as QMK. Here is a table comparing supported ZMK and QMK features: +At this point, ZMK is still missing many features compared to more developed firmware such as QMK. Here is a table comparing supported ZMK and QMK features: -| | ZMK | QMK | +| **Feature** | ZMK | QMK | |----------------------------------------------------------------------------------------------------------|:---------:|:-----------:| | Wireless Connectivity via BLE | ✅ | | | USB Connectivity | ✅ | ✅ | @@ -28,16 +28,17 @@ At this point, ZMK is still missing many features compared to more developed fir | [Encoders](feature/encoders) | ✅ | ✅ | | Basic [OLED display support](feature/displays) | ✅ | ✅ | | [RGB Underglow](feature/underglow) | ✅ | ✅ | -| One Shot Keys | | ✅ | -| Combo Keys | | ✅ | -| Macros | | ✅ | +| One Shot Keys | In Dev | ✅ | +| Combo Keys | In Dev | ✅ | +| Macros | In Dev | ✅ | | Mouse Keys | | ✅ | -| Battery Reporting | | | -| Low Power Sleep States | | | -| Low Power Mode (VCC Shutoff) | | | +| Battery Reporting | In Dev | | +| Low Power Sleep States | In Dev | | +| Low Power Mode (VCC Shutoff) | In Dev | | | Shell over BLE | | | +| Realtime Keymap Updating | In Dev | ✅ | | AVR/8 Bit | | ✅ | - +| Wide Range of ARM Chips Supported | ✅ | | ## Code Of Conduct Please note that this project is released with a From e740a83d68bfce54e2d0018d10b93c3242b3a9d9 Mon Sep 17 00:00:00 2001 From: Tsquash Date: Thu, 8 Oct 2020 23:33:58 -0500 Subject: [PATCH 03/15] Made columns wider --- docs/docs/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 5d4b50e2..62797661 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -15,7 +15,7 @@ feature. At this point, ZMK is still missing many features compared to more developed firmware such as QMK. Here is a table comparing supported ZMK and QMK features: -| **Feature** | ZMK | QMK | +| **Feature** |   ZMK   |   QMK   | |----------------------------------------------------------------------------------------------------------|:---------:|:-----------:| | Wireless Connectivity via BLE | ✅ | | | USB Connectivity | ✅ | ✅ | From 910e207dbcc17fc5120b56550270458a29e0663c Mon Sep 17 00:00:00 2001 From: Caleb Lightfoot <61706196+Tsquash@users.noreply.github.com> Date: Fri, 9 Oct 2020 11:12:10 -0500 Subject: [PATCH 04/15] Update Intro changed intro wording and link to layer tap Update intro.md --- docs/docs/intro.md | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 62797661..8348c547 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -13,32 +13,35 @@ feature. ## Features -At this point, ZMK is still missing many features compared to more developed firmware such as QMK. Here is a table comparing supported ZMK and QMK features: +At this point, ZMK is still missing many features compared to popular firmware such as QMK. Here is a table comparing supported ZMK and QMK features: | **Feature** |   ZMK   |   QMK   | |----------------------------------------------------------------------------------------------------------|:---------:|:-----------:| -| Wireless Connectivity via BLE | ✅ | | +| Multi-Device BLE Support | ✅ | | | USB Connectivity | ✅ | ✅ | -| Low Active Power Usage | ✅ | | +| Low Active Power Usage | ✅ | | | Split Keyboard Support | ✅ | ✅ | | [Keymaps and Layers](behavior/layers) | ✅ | ✅ | -| [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers)) | ✅ | ✅ | -| [Basic HID over USB](behavior/key-press) | ✅ | ✅ | +| [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers/#layer-tap)) | ✅ | ✅ | +| [Basic Keycodes](behavior/key-press) | ✅ | ✅ | | [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | -| [Encoders](feature/encoders) | ✅ | ✅ | -| Basic [OLED display support](feature/displays) | ✅ | ✅ | +| [Encoders](feature/encoders)[^1] | ✅ | ✅ | +| Proof of Concept [OLED display support](feature/displays) | ✅ | ✅ | | [RGB Underglow](feature/underglow) | ✅ | ✅ | | One Shot Keys | In Dev | ✅ | | Combo Keys | In Dev | ✅ | | Macros | In Dev | ✅ | -| Mouse Keys | | ✅ | +| Mouse Keys | | ✅ | | Battery Reporting | In Dev | | -| Low Power Sleep States | In Dev | | +| Low Power Sleep States | In Dev | | | Low Power Mode (VCC Shutoff) | In Dev | | -| Shell over BLE | | | -| Realtime Keymap Updating | In Dev | ✅ | -| AVR/8 Bit | | ✅ | -| Wide Range of ARM Chips Supported | ✅ | | +| Shell over BLE | | | +| Realtime Keymap Updating | Planned | ✅ | +| AVR/8 Bit | | ✅ | +| Wide Range of ARM Chips Supported | ✅ | | +[^1]:Note: Encoders are not currently supported on peripheral side splits. + + ## Code Of Conduct Please note that this project is released with a From 93c5ae17acd509207e8109e3307b59b9f70aa3d1 Mon Sep 17 00:00:00 2001 From: Caleb Lightfoot <61706196+Tsquash@users.noreply.github.com> Date: Fri, 9 Oct 2020 11:28:23 -0500 Subject: [PATCH 05/15] Uniformed Capitals, Added footnotes --- docs/docs/intro.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 8348c547..f0b15d54 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -22,11 +22,11 @@ At this point, ZMK is still missing many features compared to popular firmware s | Low Active Power Usage | ✅ | | | Split Keyboard Support | ✅ | ✅ | | [Keymaps and Layers](behavior/layers) | ✅ | ✅ | -| [Hold-tap](behavior/hold-tap) (which includes [mod-tap](behavior/mod-tap), [layer-tap](behavior/layers/#layer-tap)) | ✅ | ✅ | +| [Hold-Tap](behavior/hold-tap) (Which Includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | | [Basic Keycodes](behavior/key-press) | ✅ | ✅ | -| [Basic consumer (media) keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | +| [Basic consumer (Media) Keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | | [Encoders](feature/encoders)[^1] | ✅ | ✅ | -| Proof of Concept [OLED display support](feature/displays) | ✅ | ✅ | +| [OLED Display Support](feature/displays)[^2] | In Dev ✅ | | [RGB Underglow](feature/underglow) | ✅ | ✅ | | One Shot Keys | In Dev | ✅ | | Combo Keys | In Dev | ✅ | @@ -39,8 +39,8 @@ At this point, ZMK is still missing many features compared to popular firmware s | Realtime Keymap Updating | Planned | ✅ | | AVR/8 Bit | | ✅ | | Wide Range of ARM Chips Supported | ✅ | | -[^1]:Note: Encoders are not currently supported on peripheral side splits. - +[^1]: Encoders are not currently supported on peripheral side splits. +[2^]: Oleds are currently proof of concept in ZMK. ## Code Of Conduct From e2a845b2eb452abcf3eec500de06172dd08dc58a Mon Sep 17 00:00:00 2001 From: Caleb Lightfoot <61706196+Tsquash@users.noreply.github.com> Date: Fri, 9 Oct 2020 11:29:07 -0500 Subject: [PATCH 06/15] removed checkmark from zmk oled --- docs/docs/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index f0b15d54..2090984a 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -26,7 +26,7 @@ At this point, ZMK is still missing many features compared to popular firmware s | [Basic Keycodes](behavior/key-press) | ✅ | ✅ | | [Basic consumer (Media) Keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | | [Encoders](feature/encoders)[^1] | ✅ | ✅ | -| [OLED Display Support](feature/displays)[^2] | In Dev ✅ | +| [OLED Display Support](feature/displays)[^2] | In Dev | | [RGB Underglow](feature/underglow) | ✅ | ✅ | | One Shot Keys | In Dev | ✅ | | Combo Keys | In Dev | ✅ | From eb9dc37f00759940ab172e0da102f3f303483e6f Mon Sep 17 00:00:00 2001 From: Caleb Lightfoot <61706196+Tsquash@users.noreply.github.com> Date: Fri, 9 Oct 2020 11:30:14 -0500 Subject: [PATCH 07/15] fix table --- docs/docs/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 2090984a..89857a44 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -26,7 +26,7 @@ At this point, ZMK is still missing many features compared to popular firmware s | [Basic Keycodes](behavior/key-press) | ✅ | ✅ | | [Basic consumer (Media) Keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | | [Encoders](feature/encoders)[^1] | ✅ | ✅ | -| [OLED Display Support](feature/displays)[^2] | In Dev | +| [OLED Display Support](feature/displays)[^2] | In Dev | ✅ | | [RGB Underglow](feature/underglow) | ✅ | ✅ | | One Shot Keys | In Dev | ✅ | | Combo Keys | In Dev | ✅ | From d7bfe979c9a0d67b5b2a9a4f87bc496c32c4ff60 Mon Sep 17 00:00:00 2001 From: Tsquash Date: Fri, 9 Oct 2020 19:05:44 -0500 Subject: [PATCH 08/15] Fixed Footnote and added user config repo --- docs/docs/intro.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 89857a44..095ab41e 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -15,11 +15,11 @@ feature. At this point, ZMK is still missing many features compared to popular firmware such as QMK. Here is a table comparing supported ZMK and QMK features: -| **Feature** |   ZMK   |   QMK   | +| **Feature** | ZMK |QMK | |----------------------------------------------------------------------------------------------------------|:---------:|:-----------:| | Multi-Device BLE Support | ✅ | | | USB Connectivity | ✅ | ✅ | -| Low Active Power Usage | ✅ | | +| User Configuration Repositories | ✅ | | | Split Keyboard Support | ✅ | ✅ | | [Keymaps and Layers](behavior/layers) | ✅ | ✅ | | [Hold-Tap](behavior/hold-tap) (Which Includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | @@ -32,15 +32,16 @@ At this point, ZMK is still missing many features compared to popular firmware s | Combo Keys | In Dev | ✅ | | Macros | In Dev | ✅ | | Mouse Keys | | ✅ | -| Battery Reporting | In Dev | | +| Low Active Power Usage | ✅ | | | Low Power Sleep States | In Dev | | | Low Power Mode (VCC Shutoff) | In Dev | | +| Battery Reporting | In Dev | | | Shell over BLE | | | | Realtime Keymap Updating | Planned | ✅ | | AVR/8 Bit | | ✅ | | Wide Range of ARM Chips Supported | ✅ | | -[^1]: Encoders are not currently supported on peripheral side splits. -[2^]: Oleds are currently proof of concept in ZMK. +[^2]: Encoders are not currently supported on peripheral side splits. +[^1]: OLEDs are currently proof of concept in ZMK. ## Code Of Conduct From 21987d338558610ca38a48ca4109d2a1a25a4b53 Mon Sep 17 00:00:00 2001 From: Tsquash Date: Fri, 9 Oct 2020 21:50:35 -0500 Subject: [PATCH 09/15] update intro.md --- docs/docs/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 095ab41e..32222d10 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -19,7 +19,7 @@ At this point, ZMK is still missing many features compared to popular firmware s |----------------------------------------------------------------------------------------------------------|:---------:|:-----------:| | Multi-Device BLE Support | ✅ | | | USB Connectivity | ✅ | ✅ | -| User Configuration Repositories | ✅ | | +| User Configuration Repositories | ✅ | | | Split Keyboard Support | ✅ | ✅ | | [Keymaps and Layers](behavior/layers) | ✅ | ✅ | | [Hold-Tap](behavior/hold-tap) (Which Includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | From 229c8b4358afe4e9ac7dbbe176645ad4bf3cb1a2 Mon Sep 17 00:00:00 2001 From: Tsquash Date: Sat, 10 Oct 2020 12:39:36 -0500 Subject: [PATCH 10/15] Added BlueMicro Collumn --- docs/docs/intro.md | 56 +++++++++++++++++++++------------------------- 1 file changed, 26 insertions(+), 30 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 32222d10..83291812 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -5,41 +5,37 @@ sidebar_label: Introduction --- ZMK Firmware is an open source (MIT) keyboard -firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time Operating System (RTOS). - -The goal is to provide a powerful, featureful keyboard firmware that is free -of licensing issues that prevent upstream BLE support as a first-class -feature. +firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues. ## Features At this point, ZMK is still missing many features compared to popular firmware such as QMK. Here is a table comparing supported ZMK and QMK features: -| **Feature** | ZMK |QMK | -|----------------------------------------------------------------------------------------------------------|:---------:|:-----------:| -| Multi-Device BLE Support | ✅ | | -| USB Connectivity | ✅ | ✅ | -| User Configuration Repositories | ✅ | | -| Split Keyboard Support | ✅ | ✅ | -| [Keymaps and Layers](behavior/layers) | ✅ | ✅ | -| [Hold-Tap](behavior/hold-tap) (Which Includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | -| [Basic Keycodes](behavior/key-press) | ✅ | ✅ | -| [Basic consumer (Media) Keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | -| [Encoders](feature/encoders)[^1] | ✅ | ✅ | -| [OLED Display Support](feature/displays)[^2] | In Dev | ✅ | -| [RGB Underglow](feature/underglow) | ✅ | ✅ | -| One Shot Keys | In Dev | ✅ | -| Combo Keys | In Dev | ✅ | -| Macros | In Dev | ✅ | -| Mouse Keys | | ✅ | -| Low Active Power Usage | ✅ | | -| Low Power Sleep States | In Dev | | -| Low Power Mode (VCC Shutoff) | In Dev | | -| Battery Reporting | In Dev | | -| Shell over BLE | | | -| Realtime Keymap Updating | Planned | ✅ | -| AVR/8 Bit | | ✅ | -| Wide Range of ARM Chips Supported | ✅ | | +| **Feature** | ZMK | BlueMicro | QMK | +|--------------------------------------------------------------------------------------------------------|:-----------:|:------------:|:-----------:| +| Multi-Device BLE Support | ✅ | ✅ | | +| USB Connectivity | ✅ | | ✅ | +| User Configuration Repositories | ✅ | | | +| Split Keyboard Support | ✅ | ✅ | ✅ | +| [Keymaps and Layers](behavior/layers) | ✅ | ✅ | ✅ | +| [Hold-Tap](behavior/hold-tap) (Which Includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ | +| [Basic Keycodes](behavior/key-press) | ✅ | ✅ | ✅ | +| [Basic consumer (Media) Keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | ✅ | +| [Encoders](feature/encoders)[^1] | ✅ | | ✅ | +| [OLED Display Support](feature/displays)[^2] | In Dev | In Dev | ✅ | +| [RGB Underglow](feature/underglow) | ✅ | ✅ | ✅ | +| One Shot Keys | In Dev | ✅ | ✅ | +| Combo Keys | In Dev | | ✅ | +| Macros | In Dev | ✅ | ✅ | +| Mouse Keys | | ✅ | ✅ | +| Low Active Power Usage | ✅ | | | +| Low Power Sleep States | In Dev | ✅ | | +| Low Power Mode (VCC Shutoff) | In Dev | | | +| Battery Reporting | In Dev | ✅ | | +| Shell over BLE | | | | +| Realtime Keymap Updating | Planned | | ✅ | +| AVR/8 Bit | | | ✅ | +| Wide Range of ARM Chips Supported | ✅ | | | [^2]: Encoders are not currently supported on peripheral side splits. [^1]: OLEDs are currently proof of concept in ZMK. From 56ab812a6764d6ba0471f41e2806d3a7d076b8c8 Mon Sep 17 00:00:00 2001 From: Tsquash Date: Sat, 10 Oct 2020 12:53:44 -0500 Subject: [PATCH 11/15] fixed BLE part of table --- docs/docs/intro.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 83291812..ab211383 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -9,11 +9,12 @@ firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time ## Features -At this point, ZMK is still missing many features compared to popular firmware such as QMK. Here is a table comparing supported ZMK and QMK features: +At this point, ZMK is still missing many features compared to popular firmware such as QMK. Here is a table comparing supported ZMK, BlueMicro, and QMK features: | **Feature** | ZMK | BlueMicro | QMK | |--------------------------------------------------------------------------------------------------------|:-----------:|:------------:|:-----------:| -| Multi-Device BLE Support | ✅ | ✅ | | +| Low Latency BLE Support | ✅ | ✅ | | +| Multi-Device BLE Support | ✅ | | | | USB Connectivity | ✅ | | ✅ | | User Configuration Repositories | ✅ | | | | Split Keyboard Support | ✅ | ✅ | ✅ | From 593d7ff7812f2ec66d3bbafd577205137c59879f Mon Sep 17 00:00:00 2001 From: Caleb Lightfoot Date: Sat, 10 Oct 2020 22:40:14 -0500 Subject: [PATCH 12/15] made table completely visual; changed feature sentence --- docs/docs/intro.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index ab211383..c5a214d3 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -9,7 +9,8 @@ firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time ## Features -At this point, ZMK is still missing many features compared to popular firmware such as QMK. Here is a table comparing supported ZMK, BlueMicro, and QMK features: +ZMK is currently missing some features found in other popular firmware. This table compares the features supported by ZMK, BlueMicro and QMK: + | **Feature** | ZMK | BlueMicro | QMK | |--------------------------------------------------------------------------------------------------------|:-----------:|:------------:|:-----------:| @@ -19,24 +20,24 @@ At this point, ZMK is still missing many features compared to popular firmware s | User Configuration Repositories | ✅ | | | | Split Keyboard Support | ✅ | ✅ | ✅ | | [Keymaps and Layers](behavior/layers) | ✅ | ✅ | ✅ | -| [Hold-Tap](behavior/hold-tap) (Which Includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ | +| [Hold-Tap](behavior/hold-tap) (which includes [Mod-Tap](behavior/mod-tap) and [Layer-Tap](behavior/layers/#layer-tap)) | ✅ | ✅ | ✅ | | [Basic Keycodes](behavior/key-press) | ✅ | ✅ | ✅ | | [Basic consumer (Media) Keycodes](behavior/key-press#consumer-key-press) | ✅ | ✅ | ✅ | | [Encoders](feature/encoders)[^1] | ✅ | | ✅ | -| [OLED Display Support](feature/displays)[^2] | In Dev | In Dev | ✅ | +| [OLED Display Support](feature/displays)[^2] | 🚧 | 🚧 | ✅ | | [RGB Underglow](feature/underglow) | ✅ | ✅ | ✅ | -| One Shot Keys | In Dev | ✅ | ✅ | -| Combo Keys | In Dev | | ✅ | -| Macros | In Dev | ✅ | ✅ | +| One Shot Keys | 🚧 | ✅ | ✅ | +| Combo Keys | 🚧 | | ✅ | +| Macros | 🚧 | ✅ | ✅ | | Mouse Keys | | ✅ | ✅ | | Low Active Power Usage | ✅ | | | -| Low Power Sleep States | In Dev | ✅ | | -| Low Power Mode (VCC Shutoff) | In Dev | | | -| Battery Reporting | In Dev | ✅ | | -| Shell over BLE | | | | -| Realtime Keymap Updating | Planned | | ✅ | -| AVR/8 Bit | | | ✅ | -| Wide Range of ARM Chips Supported | ✅ | | | +| Low Power Sleep States | 🚧 | ✅ | | +| Low Power Mode (VCC Shutoff) | 🚧 | | | +| Battery Reporting | 🚧 | ✅ | | +| Shell over BLE | | | | +| Realtime Keymap Updating | 💡 | | ✅ | +| AVR/8 Bit | | | ✅ | +| Wide Range of ARM Chips Supported | ✅ | | | [^2]: Encoders are not currently supported on peripheral side splits. [^1]: OLEDs are currently proof of concept in ZMK. From 1ef21c57ea4d186290b1a47110885a5e2bf2f043 Mon Sep 17 00:00:00 2001 From: Caleb Lightfoot Date: Sat, 10 Oct 2020 23:03:07 -0500 Subject: [PATCH 13/15] added links to see progress of features. --- docs/docs/intro.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index c5a214d3..60fe0d22 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -31,13 +31,13 @@ ZMK is currently missing some features found in other popular firmware. This tab | Macros | 🚧 | ✅ | ✅ | | Mouse Keys | | ✅ | ✅ | | Low Active Power Usage | ✅ | | | -| Low Power Sleep States | 🚧 | ✅ | | -| Low Power Mode (VCC Shutoff) | 🚧 | | | -| Battery Reporting | 🚧 | ✅ | | +| [Low Power Sleep States](https://github.com/zmkfirmware/zmk/pull/211) | 🚧 | ✅ | | +| [Low Power Mode (VCC Shutoff)](https://github.com/zmkfirmware/zmk/pull/242) | 🚧 | | | +| [Battery Reporting](https://github.com/zmkfirmware/zmk/issues/47) | 🚧 | ✅ | | | Shell over BLE | | | | | Realtime Keymap Updating | 💡 | | ✅ | | AVR/8 Bit | | | ✅ | -| Wide Range of ARM Chips Supported | ✅ | | | +| [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | | [^2]: Encoders are not currently supported on peripheral side splits. [^1]: OLEDs are currently proof of concept in ZMK. From d4b83c3ebf6a51c563a4bdebacae65e9cb17465b Mon Sep 17 00:00:00 2001 From: Caleb Lightfoot Date: Mon, 12 Oct 2020 18:52:29 -0500 Subject: [PATCH 14/15] Increased Comprehension of Oled Footnote --- docs/docs/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 60fe0d22..fc598987 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -39,7 +39,7 @@ ZMK is currently missing some features found in other popular firmware. This tab | AVR/8 Bit | | | ✅ | | [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | | [^2]: Encoders are not currently supported on peripheral side splits. -[^1]: OLEDs are currently proof of concept in ZMK. +[^1]: OLEDs are currently a proof of concept in ZMK. ## Code Of Conduct From e4752606641c8f8393a2ac345511ac17f227fa0e Mon Sep 17 00:00:00 2001 From: Caleb Lightfoot Date: Mon, 12 Oct 2020 19:06:40 -0500 Subject: [PATCH 15/15] Revert "Increased Comprehension of Oled Footnote" This reverts commit d4b83c3ebf6a51c563a4bdebacae65e9cb17465b. --- docs/docs/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/intro.md b/docs/docs/intro.md index fc598987..60fe0d22 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -39,7 +39,7 @@ ZMK is currently missing some features found in other popular firmware. This tab | AVR/8 Bit | | | ✅ | | [Wide Range of ARM Chips Supported](https://docs.zephyrproject.org/latest/boards/index.html) | ✅ | | | [^2]: Encoders are not currently supported on peripheral side splits. -[^1]: OLEDs are currently a proof of concept in ZMK. +[^1]: OLEDs are currently proof of concept in ZMK. ## Code Of Conduct