Keyball 开源项目使用教程
1. 项目的目录结构及介绍
Keyball 项目的目录结构如下:
keyball/
├── bin/
├── keyball39/
├── keyball44/
├── keyball46/
├── keyball61/
├── qmk_firmware/
├── .gitignore
├── LICENSE
├── README.md
目录结构介绍
- bin/: 存放编译后的二进制文件。
- keyball39/: Keyball39 键盘的配置和代码。
- keyball44/: Keyball44 键盘的配置和代码。
- keyball46/: Keyball46 键盘的配置和代码。
- keyball61/: Keyball61 键盘的配置和代码。
- qmk_firmware/: QMK 固件的源代码。
- .gitignore: Git 忽略文件配置。
- LICENSE: 项目许可证文件,采用 GPL-3.0 许可证。
- README.md: 项目介绍和使用说明。
2. 项目的启动文件介绍
Keyball 项目没有明确的“启动文件”,因为它是一个键盘固件项目,主要依赖于 QMK 固件。每个键盘型号(如 Keyball39、Keyball44 等)都有其对应的配置文件和代码文件。
主要启动流程
- 编译固件: 使用 QMK 工具链编译特定键盘型号的固件。
- 烧录固件: 将编译后的固件烧录到键盘的微控制器中。
3. 项目的配置文件介绍
Keyball 项目的配置文件主要位于每个键盘型号的目录中,例如 keyball39/
、keyball44/
等。
主要配置文件
- config.h: 包含键盘的基本配置,如按键矩阵、LED 配置等。
- rules.mk: 包含编译选项和依赖项。
- keymaps/: 包含不同布局的按键映射配置。
示例配置文件路径
keyball39/
├── config.h
├── rules.mk
└── keymaps/
├── default/
│ ├── config.h
│ ├── keymap.c
│ └── rules.mk
└── other_layout/
├── config.h
├── keymap.c
└── rules.mk
配置文件介绍
- config.h: 定义键盘的基本参数,如按键数量、LED 数量等。
- rules.mk: 定义编译选项,如使用的微控制器型号、编译标志等。
- keymaps/: 包含不同布局的按键映射配置,每个布局都有独立的
config.h
和keymap.c
。
通过以上配置文件,用户可以根据自己的需求定制键盘的按键布局和功能。