HHKB_controller 项目启动与配置教程

1. 项目目录结构及介绍

HHKB_controller 项目是一个开源项目，旨在为 HHKB 键盘提供自定义控制功能。以下是项目的目录结构及其简要介绍：

HHKB_controller/
├── firmware/          # 存放固件源代码
├── doc/               # 存放项目文档
├── .gitignore         # 指定 Git 忽略的文件和目录
├── README.md          # 项目说明文件
├── license            # 项目许可证文件
└── Makefile           # 项目构建文件

• firmware/: 包含固件的源代码，是项目的核心部分。
• doc/: 存放与项目相关的文档，如用户手册、API 文档等。
• .gitignore: 指定在版本控制中应该被忽略的文件和目录，以保持仓库的整洁。
• README.md: 项目的主要说明文件，通常包含项目描述、功能、安装指南等。
• license: 项目使用的许可证文件，明确了项目的使用和分发条款。
• Makefile: 构建项目的 Makefile 文件，用于编译和构建固件。

2. 项目的启动文件介绍

项目的启动文件主要是 Makefile，该文件包含了构建项目所需的指令。以下是一个简化的 Makefile 示例：

# Makefile

# 设置编译器
CC = avr-gcc

# 设置编译器标志
CFLAGS = -mmcu=atmega32u4 -DF_CPU=16000000UL -O2 -Wall

# 设置源文件
SRC = $(wildcard firmware/*.c)

# 设置目标文件
OBJ = $(SRC:.c=.o)

# 设置可执行文件
TARGET = firmware.hex

all: $(TARGET)

$(TARGET): $(OBJ)
	$(CC) $(CFLAGS) -o $@ $(OBJ)

clean:
	rm -f $(OBJ) $(TARGET)

这个 Makefile 文件定义了如何编译项目源码，并将编译后的结果输出为 firmware.hex 文件。

3. 项目的配置文件介绍

在 HHKB_controller 项目中，配置文件可能包含在 firmware/ 目录下的 .h 头文件中。这些配置文件定义了项目使用的宏和全局变量，例如：

// config.h

// 键盘硬件配置
#define HHKB_HWrev 1

// 键盘固件版本
#define FW_VERSION "1.0.0"

// 功能特性开关
#define ENABLE NKRO  // 开启 N-Key Rollover 功能

这些配置文件允许开发者根据不同的需求和硬件配置来调整项目的行为。开发者可以通过修改这些文件中的定义来改变项目的工作方式。