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 是一个开源的键盘固件项目，支持多种键盘和自定义功能。以下是项目的主要目录结构及其介绍：

qmk_firmware/
├── builddefs/
├── data/
├── drivers/
├── keyboards/
├── layouts/
├── lib/
├── platforms/
├── quantum/
├── tests/
├── tmk_core/
├── 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/: 包含项目的数据文件。
• drivers/: 包含各种硬件驱动程序。
• keyboards/: 包含支持的键盘定义和配置。
• layouts/: 包含键盘布局文件。
• lib/: 包含项目使用的库文件。
• platforms/: 包含不同平台的支持文件。
• quantum/: 包含量子固件的核心代码。
• tests/: 包含测试代码。
• tmk_core/: 包含 TMK 固件的核心代码。
• util/: 包含各种实用工具和脚本。

2. 项目的启动文件介绍

QMK Firmware 的启动文件主要是 Makefile 和 readme.md。

Makefile

Makefile 是项目的构建文件，定义了如何编译和构建固件。通过运行 make 命令，可以根据配置生成对应的键盘固件。

readme.md

readme.md 是项目的介绍文件，包含了项目的基本信息、安装指南、使用说明等内容。

3. 项目的配置文件介绍

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

键盘配置文件

• keyboards/ergodox_ez/: ErgoDox EZ 键盘的配置文件。
• keyboards/planck/: Planck 键盘的配置文件。
• keyboards/moonlander/: Moonlander Mark I 键盘的配置文件。

配置文件结构

每个键盘的配置文件通常包含以下内容：

• config.h: 定义键盘的基本配置，如按键矩阵、LED 配置等。
• rules.mk: 定义构建规则，如使用的 MCU、时钟频率等。
• keymaps/: 包含不同的按键映射配置。

示例：ErgoDox EZ 配置文件

keyboards/ergodox_ez/
├── config.h
├── rules.mk
├── keymaps/
│   ├── default/
│   ├── oryx/
│   └── ...

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

---

以上是 QMK Firmware 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 QMK Firmware。

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