QMK Firmware 项目教程

1. 项目目录结构及介绍

QMK Firmware 项目的目录结构如下：

qmk_firmware/
├── builddefs/
├── data/
├── docs/
├── drivers/
├── keyboards/
├── layouts/
├── lib/
├── platforms/
├── quantum/
├── tests/
├── tmk_core/
├── users/
├── util/
├── clang-format
├── clangd
├── editorconfig
├── gitattributes
├── gitignore
├── gitmodules
├── Doxyfile
├── LICENSE
├── Makefile
├── doxygen-todo
├── license_GPLv2.md
├── license_GPLv3.md
├── license_Modified_BSD.md
├── nose2.cfg
├── paths.mk
├── readme.md
├── requirements-dev.txt
├── requirements.txt
├── setup.cfg
└── shell.nix

目录介绍：

• builddefs/: 包含构建定义文件。
• data/: 包含项目的数据文件。
• docs/: 包含项目的文档文件。
• drivers/: 包含键盘驱动程序。
• keyboards/: 包含支持的键盘配置文件。
• layouts/: 包含键盘布局文件。
• lib/: 包含项目的库文件。
• platforms/: 包含平台相关的文件。
• quantum/: 包含量子机械键盘的核心代码。
• tests/: 包含测试文件。
• tmk_core/: 包含 TMK 键盘固件的核心代码。
• users/: 包含用户自定义文件。
• util/: 包含实用工具文件。
• clang-format: 包含 Clang 格式化配置文件。
• clangd: 包含 Clangd 配置文件。
• editorconfig: 包含编辑器配置文件。
• gitattributes: 包含 Git 属性配置文件。
• gitignore: 包含 Git 忽略配置文件。
• gitmodules: 包含 Git 子模块配置文件。
• Doxyfile: 包含 Doxygen 配置文件。
• LICENSE: 包含项目许可证文件。
• Makefile: 包含项目的 Makefile 文件。
• doxygen-todo: 包含 Doxygen 待办事项文件。
• license_GPLv2.md: 包含 GPLv2 许可证文件。
• license_GPLv3.md: 包含 GPLv3 许可证文件。
• license_Modified_BSD.md: 包含修改后的 BSD 许可证文件。
• nose2.cfg: 包含 Nose2 配置文件。
• paths.mk: 包含路径配置文件。
• readme.md: 包含项目的 README 文件。
• requirements-dev.txt: 包含开发依赖文件。
• requirements.txt: 包含项目依赖文件。
• setup.cfg: 包含项目设置配置文件。
• shell.nix: 包含 Nix 配置文件。

2. 项目启动文件介绍

QMK Firmware 项目的启动文件主要是 Makefile。这个文件定义了项目的构建规则和依赖关系。通过运行 make 命令，可以编译和构建项目。

Makefile 主要功能：

• 编译: 通过 make 命令编译项目。
• 清理: 通过 make clean 命令清理编译生成的文件。
• 烧录: 通过 make flash 命令将编译后的固件烧录到键盘。

3. 项目配置文件介绍

QMK Firmware 项目的配置文件主要位于 keyboards/ 目录下，每个键盘都有自己的配置文件。以下是一些常见的配置文件：

配置文件示例：

• config.h: 包含键盘的基本配置，如按键矩阵、LED 配置等。
• rules.mk: 包含编译规则和选项。
• keymaps/: 包含不同布局的按键映射文件。

配置文件示例：

// config.h
#define MATRIX_ROWS 4
#define MATRIX_COLS 12

#define LED_CAPS_LOCK_PIN B5
#define LED_NUM_LOCK_PIN B6
#define LED_SCROLL_LOCK_PIN B7

# rules.mk
BOOTMAGIC_ENABLE = no
MOUSEKEY_ENABLE = yes
EXTRAKEY_ENABLE = yes
CONSOLE_ENABLE = no
COMMAND_ENABLE = no
NKRO_ENABLE = yes
BACKLIGHT_ENABLE = no
RGBLIGHT_ENABLE = yes
AUDIO_ENABLE = no

通过这些配置文件，用户可以自定义键盘的行为和功能。