Urchin 项目使用教程

1. 项目目录结构及介绍

Urchin 项目的目录结构如下：

urchin/
├── 3d-prints/
│   └── gallery/
├── lib/
├── plate-case/
├── .gitignore
├── LICENSE
├── README.md
├── fp-lib-table
├── main.kibot.yaml
├── main.kicad_pcb
├── main.kicad_prl
├── main.kicad_pro
├── main.kicad_sch

目录结构介绍

• 3d-prints/: 包含与3D打印相关的文件，特别是 gallery/ 目录，可能包含3D打印模型的展示图片。
• lib/: 包含项目使用的库文件。
• plate-case/: 包含与键盘外壳设计相关的文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
• LICENSE: 项目的许可证文件，本项目使用 MIT 许可证。
• README.md: 项目的介绍文件，包含项目的基本信息、使用说明等。
• fp-lib-table: KiCad 项目使用的库表文件。
• main.kibot.yaml: KiBot 配置文件，用于自动化生成 PCB 相关文件。
• main.kicad_pcb: KiCad PCB 设计文件。
• main.kicad_prl: KiCad 项目库文件。
• main.kicad_pro: KiCad 项目文件。
• main.kicad_sch: KiCad 原理图文件。

2. 项目启动文件介绍

Urchin 项目的主要启动文件是 main.kicad_pcb 和 main.kicad_sch。

• main.kicad_pcb: 这是 KiCad 的 PCB 设计文件，包含了键盘的电路布局和连接信息。通过打开这个文件，可以使用 KiCad 软件进行 PCB 的设计和编辑。
• main.kicad_sch: 这是 KiCad 的原理图文件，包含了键盘的电路原理图。通过打开这个文件，可以查看和编辑键盘的电路设计。

3. 项目配置文件介绍

Urchin 项目的主要配置文件包括：

• main.kibot.yaml: 这是 KiBot 的配置文件，用于自动化生成 PCB 相关文件。通过配置这个文件，可以自动化生成 Gerber 文件、BOM 表等。
• fp-lib-table: 这是 KiCad 项目使用的库表文件，定义了项目中使用的库文件路径。通过编辑这个文件，可以添加或移除项目中使用的库文件。

配置文件示例

main.kibot.yaml

# KiBot configuration file
version: 1
jobs:
  - name: Generate Gerber files
    type: gerber
    dir: gerber_output
    options:
      create_gerber_job_file: true
      use_aux_axis_as_origin: true

fp-lib-table

(fp_lib_table
  (lib (name my_lib)(type KiCad)(uri ${KIPRJMOD}/lib/my_lib.pretty)(options "")(descr "My custom library"))
)

通过以上配置文件，可以自动化生成 PCB 相关文件，并管理项目中使用的库文件。