Ergodox Case 开源项目启动与配置指南

1. 项目的目录结构及介绍

Ergodox Case 是一个开源项目，用于创建自定义机械键盘的外壳。以下是项目的目录结构及各部分功能的简要介绍：

ergodox-case/
├── README.md          # 项目说明文件
├── docs/              # 文档目录
│   ├── design/        # 设计文件和相关文档
│   │   ├── cad/       # CAD图纸
│   │   └── images/    # 设计图像
│   └── instructions/  # 组装说明
├── models/            # 3D模型文件
│   ├── stl/           # STL格式模型文件
│   └── scad/          # OpenSCAD 脚本文件
└── scripts/          # 脚本文件，用于生成模型等

• README.md：项目的主说明文件，包含项目概述、安装指南和贡献指南。
• docs/：存放项目文档的目录，包括设计文件和组装说明。
• models/：存放键盘外壳的3D模型文件，包括STL格式文件和OpenSCAD脚本文件。
• scripts/：存放用于生成或处理模型的各种脚本。

2. 项目的启动文件介绍

项目的启动主要是通过scripts/目录下的脚本实现的。以下是几个关键的启动文件：

• generate_models.sh：这是一个bash脚本，用于生成键盘外壳的STL模型文件。运行此脚本会根据models/scad/目录下的OpenSCAD脚本生成STL文件。
• assemble.sh：另一个bash脚本，用于辅助组装键盘外壳。它可能会调用generate_models.sh来生成必要的模型文件，并提供组装步骤。

要启动项目，你需要在命令行中运行generate_models.sh脚本来生成模型文件。

cd path/to/ergodox-case/scripts
chmod +x generate_models.sh
./generate_models.sh

3. 项目的配置文件介绍

项目的配置主要是通过修改models/scad/目录下的OpenSCAD脚本文件来实现的。以下是几个关键的配置文件：

• ergodox.scad：这是主OpenSCAD脚本文件，定义了键盘外壳的基本结构和参数。你可以在这里调整键盘的大小、形状和其他设计参数。
• config.scad：配置文件，包含了各种全局参数，如材料厚度、螺丝尺寸等。通过修改这些参数，可以调整键盘外壳的设计以适应不同的需求。

要配置项目，你需要编辑config.scad文件，根据需要进行调整，然后重新运行generate_models.sh脚本来生成更新后的模型文件。