ZMK-Nodefree-Config 项目使用教程

1. 项目目录结构及介绍

ZMK-Nodefree-Config 项目的目录结构如下：

zmk-nodefree-config/
├── config/
│   ├── corne-keymap/
│   ├── zmk-helpers/
│   │   ├── helper.h
│   │   └── ...
│   └── ...
├── include/
│   └── zmk-helpers/
│       ├── helper.h
│       └── ...
├── zephyr/
│   └── ...
├── .editorconfig
├── .gitattributes
├── .prettierrc
├── LICENSE
└── README.md

目录结构介绍

• config/: 包含项目的配置文件和键盘映射文件。
  • corne-keymap/: 特定键盘的映射文件。
  • zmk-helpers/: 包含简化 ZMK 键盘映射配置的辅助宏文件。
• include/: 包含项目的头文件。
  • zmk-helpers/: 包含辅助宏的头文件。
• zephyr/: 包含 Zephyr RTOS 相关的文件。
• .editorconfig: 编辑器配置文件。
• .gitattributes: Git 属性配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。

2. 项目的启动文件介绍

项目的启动文件主要是 config/corne-keymap/corne.keymap，该文件定义了键盘的按键映射。启动时，ZMK 会加载这个文件来配置键盘的行为。

启动文件内容示例

#include "zmk-helpers/helper.h"

// 定义键盘的按键映射
ZMK_BEHAVIOR(my_behavior, &kp SPACE)
ZMK_COMBO(my_combo, &kp ENTER, 1, 2)

// 其他配置...

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，包括 corne-keymap/corne.keymap 和 zmk-helpers/ 目录中的辅助宏文件。

配置文件介绍

• corne.keymap: 定义了特定键盘的按键映射。
• zmk-helpers/helper.h: 包含简化 ZMK 键盘映射配置的辅助宏。

配置文件示例

// config/corne-keymap/corne.keymap
#include "zmk-helpers/helper.h"

// 定义键盘的按键映射
ZMK_BEHAVIOR(my_behavior, &kp SPACE)
ZMK_COMBO(my_combo, &kp ENTER, 1, 2)

// 其他配置...

// config/zmk-helpers/helper.h
#define ZMK_BEHAVIOR(name, behavior) \
    ZMK_BEHAVIOR_DEF(name, behavior)

#define ZMK_COMBO(name, behavior, key1, key2) \
    ZMK_COMBO_DEF(name, behavior, key1, key2)

// 其他辅助宏定义...

通过这些配置文件，用户可以自定义键盘的行为和按键映射，实现个性化的键盘配置。