Prusa-Firmware-Buddy 项目使用教程

Prusa-Firmware-Buddy 项目使用教程

Prusa-Firmware-Buddy Firmware for the Original Prusa MINI, Original Prusa MK4 and the Original Prusa XL 3D printers by Prusa Research. 项目地址: https://gitcode.com/gh_mirrors/pr/Prusa-Firmware-Buddy

1. 项目目录结构及介绍

Prusa-Firmware-Buddy 项目的目录结构如下：

Prusa-Firmware-Buddy/
├── cmake/
├── doc/
├── include/
├── lib/
├── src/
├── tests/
├── utils/
├── clang-format
├── clangd
├── cmake-format.py
├── git-blame-ignore-revs
├── gitattributes
├── gitignore
├── pre-commit-config.yaml
├── CMakeLists.txt
├── CMakePresets.json
├── Doxyfile
├── LICENSE.md
├── ProjectOptions.cmake
├── README.md
├── pyproject.toml
├── requirements.txt
└── version.txt

目录介绍：

• cmake/: 包含 CMake 配置文件。
• doc/: 包含项目文档。
• include/: 包含项目的头文件。
• lib/: 包含项目依赖的库文件。
• src/: 包含项目的源代码。
• tests/: 包含项目的测试代码。
• utils/: 包含项目的实用工具脚本。
• clang-format: 用于代码格式化的配置文件。
• clangd: 用于代码分析的配置文件。
• cmake-format.py: CMake 文件格式化脚本。
• git-blame-ignore-revs: Git 忽略特定提交的配置文件。
• gitattributes: Git 属性配置文件。
• gitignore: Git 忽略文件配置文件。
• pre-commit-config.yaml: 预提交钩子配置文件。
• CMakeLists.txt: 主 CMake 配置文件。
• CMakePresets.json: CMake 预设配置文件。
• Doxyfile: Doxygen 文档生成配置文件。
• LICENSE.md: 项目许可证文件。
• ProjectOptions.cmake: 项目选项配置文件。
• README.md: 项目自述文件。
• pyproject.toml: Python 项目配置文件。
• requirements.txt: Python 依赖包列表。
• version.txt: 项目版本文件。

2. 项目启动文件介绍

项目的启动文件主要是 utils/build.py，这是一个 Python 脚本，用于构建项目。以下是启动文件的简要介绍：

utils/build.py

该脚本是项目的主要构建脚本，用于编译和生成固件。它支持多种参数选项，可以根据需要选择不同的构建配置。

使用示例：

python utils/build.py --preset mini --build-type debug

该命令将使用 mini 预设和 debug 构建类型来构建固件。

3. 项目配置文件介绍

项目中有多个配置文件，以下是一些关键配置文件的介绍：

CMakeLists.txt

这是项目的主 CMake 配置文件，定义了项目的构建规则和依赖关系。

CMakePresets.json

该文件定义了 CMake 的预设配置，可以方便地切换不同的构建配置。

Doxyfile

Doxygen 文档生成配置文件，用于生成项目的 API 文档。

pre-commit-config.yaml

预提交钩子配置文件，用于在提交代码前自动执行代码检查和格式化。

pyproject.toml

Python 项目配置文件，定义了 Python 项目的依赖和构建配置。

requirements.txt

Python 依赖包列表，列出了项目所需的 Python 包。

version.txt

项目版本文件，记录了当前项目的版本号。

通过这些配置文件，开发者可以方便地管理和配置项目的构建和运行环境。

Prusa-Firmware-Buddy Firmware for the Original Prusa MINI, Original Prusa MK4 and the Original Prusa XL 3D printers by Prusa Research. 项目地址: https://gitcode.com/gh_mirrors/pr/Prusa-Firmware-Buddy