Skip to content

Commit

Permalink
Attempt to address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@caksoylar
caksoylar committed Jan 16, 2025
1 parent 076fc4d commit d8da6cd
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions docs/docs/intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ slug: /
---

ZMK Firmware is an open source (MIT) keyboard firmware built on the [Zephyr™ Project](https://zephyrproject.org/) Real Time Operating System (RTOS).
ZMK's goal is to provide a modern and powerful firmware that is wireless-first and free of licensing issues.
ZMK's goal is to provide a modern and powerful firmware that is designed for power-efficiency, flexibility, and broad hardware support.
ZMK is capable of being used for both wired and wireless input devices.

## Features

Expand All @@ -14,22 +15,22 @@ Below table lists major features/capabilities currently supported in ZMK, as wel
| Legend: | ✅ Supported | 🚧 Under Development | ❌ Not Planned |
| :------ | :----------- | :------------------- | -------------- |

| Hardware | Support |
| ----------------------------------------------------------------------------------------------- | :-----: |
| [Wireless Split Keyboards](features/split-keyboards.md) | ✅ |
| Wired Split Keyboards | 🚧 |
| [Low Active Power Usage](/power-profiler) | ✅ |
| [Encoders](features/encoders.md) | ✅ |
| [LED-based Lighting](features/lighting.md) | ✅ |
| [Displays](features/displays.md) | 🚧 |
| [Pointing Devices](features/pointing.md) | ✅ |
| Multitouch Touchpads (PTP) | 🚧 |
| [Low Power Sleep States](features/low-power-states.md) | ✅ |
| [Low Power Mode (VCC Shutoff) for Peripherals](keymaps/behaviors/power.md) | ✅ |
| Improved Power Handling for Multiple Peripherals | 🚧 |
| [Battery Level Reporting](features/battery.md) | ✅ |
| [Support for a Wide Range of ARM Chips](https://docs.zephyrproject.org/3.5.0/boards/index.html) | ✅ |
| Support for AVR/8-Bit Chips | ❌ |
| Hardware | Support |
| ------------------------------------------------------------------------------------------------------------- | :-----: |
| [Wireless Split Keyboards](features/split-keyboards.md) | ✅ |
| Wired Split Keyboards | 🚧 |
| [Low Active Power Usage](/power-profiler) | ✅ |
| [Encoders](features/encoders.md) | ✅ |
| [LED-based Lighting](features/lighting.md) | ✅ |
| [Displays](features/displays.md) | 🚧 |
| [Pointing Devices](features/pointing.md) | ✅ |
| Multitouch Touchpads (PTP) | 🚧 |
| [Low Power Sleep States](features/low-power-states.md) | ✅ |
| [Low Power Mode (VCC Shutoff) for Peripherals](keymaps/behaviors/power.md) | ✅ |
| Improved Power Handling for Multiple Peripherals | 🚧 |
| [Battery Level Reporting](features/battery.md) | ✅ |
| [Support for a Wide Range of 32-bit Microcontrollers](https://docs.zephyrproject.org/3.5.0/boards/index.html) | ✅ |
| Support for AVR/8-bit Chips | ❌ |

| Connectivity | Support |
| --------------------------------------------------------------- | :-----: |
Expand All @@ -41,7 +42,8 @@ Below table lists major features/capabilities currently supported in ZMK, as wel
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | :-----: |
| [User Configuration Repositories](user-setup.mdx) | ✅ |
| [Keymaps and Layers](keymaps/index.mdx) | ✅ |
| [Wide Range of Keycodes (Including Media and Consumer)](keymaps/list-of-keycodes.mdx) | ✅ |
| [Wide Range of Keycodes](keymaps/list-of-keycodes.mdx) | ✅ |
| [Flexible Behavior System](keymaps/behaviors/index.mdx) | ✅ |
| [Hold-Taps](keymaps/behaviors/hold-tap.mdx) (including [Mod-Tap](keymaps/behaviors/mod-tap.md) and [Layer-Tap](keymaps/behaviors/layers.md#layer-tap)) | ✅ |
| [Tap-Dances](keymaps/behaviors/tap-dance.mdx) | ✅ |
| [Sticky (One Shot) Keys](keymaps/behaviors/sticky-key.md) | ✅ |
Expand Down

0 comments on commit d8da6cd

Please sign in to comment.