Ergogen 开源项目教程

Ergogen 开源项目教程

ergogenErgonomic keyboard layout generator项目地址:https://gitcode.com/gh_mirrors/er/ergogen

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

Ergogen 项目的目录结构如下：

ergogen/
├── docs/
├── examples/
├── src/
│   ├── cli.js
│   ├── config.js
│   ├── parser.js
│   ├── renderer.js
│   └── utils.js
├── test/
├── .gitignore
├── LICENSE
├── package.json
└── README.md

目录介绍

• docs/: 包含项目的文档文件。
• examples/: 包含一些示例配置文件。
• src/: 包含项目的主要源代码文件。
  • cli.js: 命令行接口文件。
  • config.js: 配置处理文件。
  • parser.js: 解析器文件。
  • renderer.js: 渲染器文件。
  • utils.js: 工具函数文件。
• test/: 包含测试文件。
• .gitignore: Git 忽略文件。
• LICENSE: 项目许可证文件。
• package.json: 项目依赖和脚本文件。
• README.md: 项目介绍文件。

2. 项目的启动文件介绍

项目的启动文件是 src/cli.js。这个文件负责处理命令行参数，并调用其他模块来完成配置文件的解析和生成。

启动文件功能

• 解析命令行参数。
• 读取配置文件。
• 调用解析器和渲染器生成输出文件。

3. 项目的配置文件介绍

项目的配置文件通常是一个 YAML 或 JSON 文件，用于定义键盘布局、板子、外壳和 PCB 的参数。

配置文件示例

points:
  SW1: { x: 0, y: 0 }
  SW2: { x: 1, y: 0 }
  SW3: { x: 2, y: 0 }
  SW4: { x: 3, y: 0 }

cases:
  bottom:
    type: simple
    thickness: 3

pcbs:
  main:
    type: simple
    thickness: 1.6

配置文件参数

• points: 定义键盘开关的位置。
• cases: 定义键盘外壳的参数。
• pcbs: 定义 PCB 的参数。

通过这些配置文件，用户可以自定义键盘的布局和结构，并生成相应的 DXF 文件、OpenJSCAD 脚本和 kicad_pcb 文件。

ergogenErgonomic keyboard layout generator项目地址:https://gitcode.com/gh_mirrors/er/ergogen