Universal-G-Code-Sender 项目教程
1. 项目的目录结构及介绍
Universal-G-Code-Sender 是一个跨平台的 G-Code 发送器,支持 GRBL、Smoothieware、TinyG 和 G2core。项目的目录结构如下:
Universal-G-Code-Sender/
├── idea/
│ └── runConfigurations/
├── mvn/
│ └── new-module-archetype/
├── pictures/
├── scripts/
├── test_files/
├── ugs-classic/
├── ugs-cli/
├── ugs-core/
├── ugs-pendant/
├── ugs-platform/
├── codebeatignore
├── codecov.yml
├── gitignore
├── travis.yml
├── COPYING
├── README.md
├── crowdin.yml
├── pom.xml
├── run_classic.sh
└── run_platform.sh
目录介绍
idea/runConfigurations/
: 包含 IntelliJ IDEA 的运行配置文件。mvn/new-module-archetype/
: Maven 模块的模板。pictures/
: 项目相关的图片文件。scripts/
: 项目使用的脚本文件。test_files/
: 测试文件。ugs-classic/
: UGS 经典版本的源代码。ugs-cli/
: UGS 命令行接口的源代码。ugs-core/
: UGS 核心功能的源代码。ugs-pendant/
: UGS 挂件功能的源代码。ugs-platform/
: UGS 平台版本的源代码。codebeatignore
: codebeat 忽略文件。codecov.yml
: Codecov 配置文件。gitignore
: Git 忽略文件。travis.yml
: Travis CI 配置文件。COPYING
: 许可证文件。README.md
: 项目说明文件。crowdin.yml
: Crowdin 翻译配置文件。pom.xml
: Maven 项目对象模型文件。run_classic.sh
: 启动 UGS 经典版本的脚本。run_platform.sh
: 启动 UGS 平台版本的脚本。
2. 项目的启动文件介绍
项目提供了两个主要的启动脚本:
run_classic.sh
: 用于启动 UGS 经典版本。run_platform.sh
: 用于启动 UGS 平台版本。
启动脚本介绍
-
run_classic.sh
:#!/bin/bash java -jar ugs-classic/target/ugs-classic-version.jar
该脚本会启动 UGS 经典版本的应用程序。
-
run_platform.sh
:#!/bin/bash java -jar ugs-platform/target/ugs-platform-version.jar
该脚本会启动 UGS 平台版本的应用程序。
3. 项目的配置文件介绍
项目的配置文件主要包括以下几个部分:
pom.xml
: Maven 项目配置文件,定义了项目的依赖、构建和部署等信息。travis.yml
: Travis CI 配置文件,定义了持续集成的工作流程。codecov.yml
: Codecov 配置文件,用于代码覆盖率的报告。crowdin.yml
: Crowdin 翻译配置文件,用于项目的国际化和本地化。
配置文件介绍
pom.xml
:<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.willwinder.ugs</groupId> <artifactId>ugs-platform</artifactId> <version>2.1.8</version> <packaging>jar</packaging> <name>Universal G-Code Sender</name> <dependencies> <!-- 项目依赖 --> </dependencies> <build> <!-- 构建配置 --> </build