QMK Firmware 使用教程

QMK Firmware 使用教程

qmk_firmware QMK, forked for ZSA's Oryx Configurator (to safeguard stability) 项目地址: https://gitcode.com/gh_mirrors/qmkf/qmk_firmware

1. 项目介绍

QMK Firmware 是一个开源的键盘固件，广泛用于自定义键盘的编程和配置。ZSA 公司为了其 Oryx 配置器（Oryx Configurator）的稳定性，对 QMK Firmware 进行了分叉，并维护了一个轻量级的版本。这个版本仅包含 ZSA 所需的键盘代码，以保持代码库的简洁和高效。

2. 项目快速启动

2.1 环境设置

首先，你需要设置本地构建环境来手动创建固件镜像。你可以按照以下步骤进行操作：

1. 克隆仓库：

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

2. 设置构建环境：

   qmk setup zsa/qmk_firmware -b firmware23
   

2.2 构建固件

在设置好环境后，你可以使用以下命令来构建固件：

qmk compile -kb <keyboard_name> -km default

例如，如果你要为 ErgoDox EZ 构建固件，可以使用：

qmk compile -kb ergodox_ez -km default

2.3 刷写固件

构建完成后，你可以使用以下命令将固件刷写到键盘上：

qmk flash -kb <keyboard_name> -km default

3. 应用案例和最佳实践

3.1 自定义键盘布局

QMK Firmware 允许用户自定义键盘布局。你可以通过编辑 keyboards/<keyboard_name>/keymaps/default/keymap.c 文件来实现。例如，你可以添加自定义的宏或修改按键映射。

3.2 使用 Oryx Configurator

ZSA 的 Oryx Configurator 是一个图形化的工具，可以帮助用户轻松配置键盘布局。你可以访问 Oryx Configurator 并按照提示进行操作。

4. 典型生态项目

4.1 QMK Toolbox

QMK Toolbox 是一个用于刷写 QMK 固件的图形化工具。它支持多种键盘和固件格式，使得刷写过程更加简单和直观。

4.2 VIA Configurator

VIA Configurator 是另一个用于配置 QMK 键盘的工具。它允许用户在不重新编译固件的情况下实时修改键盘布局。

通过以上步骤，你可以快速上手并使用 QMK Firmware 进行键盘的自定义和配置。

qmk_firmware QMK, forked for ZSA's Oryx Configurator (to safeguard stability) 项目地址: https://gitcode.com/gh_mirrors/qmkf/qmk_firmware