QMK Firmware 使用教程

1. 项目介绍

QMK Firmware 是一个开源的键盘固件项目，支持 Atmel AVR 和 Arm USB 系列的微控制器。它提供了丰富的功能，允许用户完全自定义键盘的行为和功能。QMK Firmware 兼容超过 3000 种键盘，并且社区活跃，提供了大量的支持和反馈。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保你的系统已经安装了以下工具：

• Git
• Python 3
• QMK Toolbox（可选，用于刷写固件）

2.2 克隆项目

首先，克隆 QMK Firmware 仓库到本地：

git clone https://github.com/qmk/qmk_firmware.git
cd qmk_firmware

2.3 设置环境

运行以下命令来设置 QMK 环境：

util/qmk_install.sh

2.4 编译固件

选择你要编译的键盘，例如 planck：

qmk compile -kb planck/rev6 -km default

2.5 刷写固件

将键盘连接到电脑，并使用 QMK Toolbox 或其他工具刷写固件：

qmk flash -kb planck/rev6 -km default

3. 应用案例和最佳实践

3.1 自定义按键映射

QMK Firmware 允许用户自定义按键映射。你可以在 keyboards/<keyboard_name>/keymaps/ 目录下创建一个新的按键映射文件夹，并在其中定义你的按键布局。

例如，创建一个新的按键映射文件夹：

mkdir -p keyboards/planck/keymaps/my_custom_keymap

然后在 my_custom_keymap 文件夹中创建 keymap.c 文件，定义你的按键映射。

3.2 使用 QMK Configurator

QMK Configurator 是一个在线工具，允许用户通过图形界面自定义键盘布局。你可以访问 QMK Configurator 来创建和下载自定义的固件。

4. 典型生态项目

4.1 VIA

VIA 是一个允许用户在运行时自定义按键映射的工具。它与 QMK Firmware 兼容，提供了更灵活的按键映射调整方式。

4.2 ZSA Moonlander

ZSA Moonlander 是一款基于 QMK Firmware 的键盘，提供了丰富的自定义选项和功能。它是一个典型的应用案例，展示了 QMK Firmware 的强大功能。

4.3 Clueboard

Clueboard 是另一个基于 QMK Firmware 的键盘项目，提供了多种键盘布局和自定义选项。它展示了 QMK Firmware 在不同键盘上的广泛应用。

通过以上步骤，你可以快速上手 QMK Firmware，并开始自定义你的键盘。