Auto Build Marlin 项目使用教程

1. 项目目录结构及介绍

Auto Build Marlin 项目的目录结构如下：

• .github/
  • 存放 GitHub 相关的配置文件。
• img/
  • 存放项目相关的图片资源。
• resources/
  • 存放项目资源文件，如配置文件模板等。
• .editorconfig
  • 定义代码编辑器的配置规范。
• .gitignore
  • 指定 Git 忽略的文件和目录。
• .vscodeignore
  • Visual Studio Code 忽略的文件和目录。
• CHANGELOG.md
  • 记录项目的历史更新和修改。
• LICENSE
  • 项目的开源协议，本项目采用 GPL-3.0 协议。
• README.md
  • 项目说明文件。
• extension.js
  • Visual Studio Code 扩展的主要 JavaScript 文件。
• icon.png
  • 扩展的图标文件。
• package.json
  • 定义 Visual Studio Code 扩展的元数据和入口点。
• package.nls.json
  • 国际化相关的配置文件。
• proto.js
  • 项目中的一个 JavaScript 文件，具体功能视项目而定。

2. 项目的启动文件介绍

在 Auto Build Marlin 项目中，extension.js 是主要的启动文件。该文件负责初始化 Visual Studio Code 扩展，注册命令和特性提供者。

// 伪代码，具体内容需要根据实际文件内容编写
// 引入需要的模块和文件
const vscode = require('vscode');
const abm = require('./abm');
const prefs = require('./prefs');
// ...

// 注册扩展提供的命令
function activate(context) {
    // 注册命令
    // ...
}

// 当扩展被关闭时调用的清理函数
function deactivate() {
    // 清理资源
    // ...
}

// 导出模块
exports.activate = activate;
exports.deactivate = deactivate;

3. 项目的配置文件介绍

Auto Build Marlin 项目中，配置文件主要是指 Configuration.h 和 Configuration_adv.h。这些文件包含了 Marlin 固件的所有配置选项。

• Configuration.h
  • 主要配置文件，包含基本的机器参数和固件设置。
• Configuration_adv.h
  • 高级配置文件，包含更高级的选项，适合有经验的用户。

用户可以通过 Visual Studio Code 的 Config Editor 来编辑这些配置文件。Config Editor 提供了一个搜索过滤器来帮助用户快速找到他们需要的选项，并且可以显示或隐藏禁用的选项和注释。

在 Config Editor 中，用户可以：

• 使用导航侧边栏查看单个隔离的章节或全部章节。
• 使用“过滤”字段按名称查找选项。
• 点击“显示/隐藏禁用项”按钮来显示或隐藏禁用的选项。
• 点击“显示/隐藏注释”按钮来显示或隐藏注释。
• 点击章节标题来展开或折叠该章节。

通过编辑这些配置文件，用户可以根据自己的需求和硬件配置来定制 Marlin 固件。