QMK Firmware 项目使用教程

1. 项目目录结构及介绍

QMK Firmware 项目是一个开源键盘控制器固件，适用于 Atmel AVR 和 ARM 控制器。以下是项目的目录结构及其简要介绍：

• .github/: 存放 GitHub 相关的配置文件。
• .vscode/: Visual Studio Code 编辑器的配置文件。
• bin/: 存放编译后的固件文件。
• docs/: 项目文档。
• drivers/: 设备驱动程序。
• keyboards/: 键盘配置文件，包括不同键盘的布局和设置。
• layouts/: 键盘布局文件。
• lib/: 通用库文件。
• platforms/: 平台相关代码，如 ChibiOS。
• quantum/: QMK 核心代码。
• tests/: 测试代码。
• tmk_core/: TMK 核心代码，QMK 的基础。
• users/: 用户自定义代码。
• util/: 实用工具代码。
• common.mk: 通用构建配置。
• common_features.mk: 通用功能配置。
• doxygen-todo: Doxygen 文档待办事项。
• license_GPLv2.md: GPL v2 许可证文件。
• license_GPLv3.md: GPL v3 许可证文件。
• license_Modified_BSD.md: 修改后的 BSD 许可证文件。
• Makefile: 主构建文件。
• readme.md: 项目说明文件。
• requirements-dev.txt: 开发环境依赖。
• requirements.txt: 项目依赖。

2. 项目的启动文件介绍

项目的启动文件是 Makefile。这是构建项目的主要文件，它定义了构建过程和所需依赖。以下是一些重要的构建目标：

• default: 默认构建目标，编译固件。
• clean: 清除构建产物。
• docs: 构建文档。
• test: 运行测试。

要编译固件，可以在项目根目录下运行以下命令：

make

3. 项目的配置文件介绍

项目的配置文件主要位于 keyboards/ 目录下，每个键盘都有一个对应的配置文件。以下是配置文件中可能包含的几个关键部分：

• config.h: 键盘配置头文件，定义键盘特定的宏和设置。
• keymap.h: 键盘映射文件，定义按键与功能之间的映射关系。
• rules.mk: 构建规则文件，定义构建过程特定的规则和选项。

例如，对于 Planck 键盘，配置文件可能如下所示：

# Planck 配置文件示例

# 键盘模型
MCU = at90usb1286

# 编译器选项
BOOTLOADER = at90usb1286bootloader
fdc прошивка
OPT_DEFS += -DONLY_QMK
OPT_DEFS += -DUSE_CHIBIOS
OPT_DEFS += -DUSEushima

# 键盘矩阵尺寸
MATRIX_ROWS = 4
MATRIX_COLS = 12

# 键盘布局
KEYMAPS += planck/rev1

# 特殊功能键
EXTRAKEY_ENABLE = yes
 AUDIO_ENABLE = no

在配置文件中，你可以根据需要自定义键盘的行为和功能。完成配置后，重新运行 make 命令以编译更新后的固件。