键盘控制器固件 QMK Firmware 使用指南

1. 项目介绍

QMK Firmware 是一款开源的键盘控制器固件，基于 tmk_keyboard 固件开发，为 Atmel AVR 和 ARM 控制器提供了一些有用的功能。该项目特别为 OLKB 产品线、ErgoDox EZ 键盘以及 Clueboard 产品线进行了优化。

QMK Firmware 支持多种键盘布局，包括 Planck、Preonic、ErgoDox EZ、Clueboard、Cluepad 和 Atreus 等。项目由 Jack Humbert 以及社区贡献者共同开发与维护。

2. 项目快速启动

以下是快速启动 QMK Firmware 的步骤：

安装依赖

1. 安装 Git：

   sudo apt-get install git
   

2. 克隆项目：

   git clone https://github.com/callum-oakley/qmk_firmware.git
   cd qmk_firmware
   

3. 安装编译工具链（以 Ubuntu 为例）：

   sudo apt-get install build-essential libusb-dev lib.awtextra-dev
   

4. 编译固件：

   make BOARD=your_board
   

   其中 your_board 需要替换为你所使用的键盘型号。

5. 烧录固件到键盘：

   make BOARD=your_board upload
   

   同样，your_board 需要替换为你所使用的键盘型号。

3. 应用案例和最佳实践

自定义键盘布局

你可以通过修改 keyboards/your_board/keymaps/ 目录下的 keymap.c 文件来自定义键盘布局。

使用宏命令

QMK Firmware 支持宏命令，你可以在 keymaps/your_board/keymaps/your_keymap.h 文件中定义宏命令。

键盘灯光效果

QMK Firmware 支持多种灯光效果，你可以在 keymaps/your_board/keymaps/your_keymap.h 文件中配置灯光效果。

4. 典型生态项目

以下是一些基于 QMK Firmware 的典型生态项目：

• ErgoDox EZ：一款开源的 Ergonomic 机械键盘，支持多种自定义功能。
• Planck：一款极简主义的机械键盘，支持全键盘自定义。
• Clueboard：一款模块化的机械键盘，支持多种键盘布局和自定义功能。

通过以上指南，你可以开始使用 QMK Firmware 来自定义你的机械键盘，享受开源带来的无限可能。