Autodesk Synthesis 开源项目使用说明

1. 项目目录结构及介绍

Autodesk Synthesis 项目是一个面向 FIRST® 机器人竞赛的仿真工具，旨在帮助队伍设计、规划、测试和练习。以下是项目的目录结构及其简要介绍：

.
├── .github/                    # GitHub 专用配置文件
├── .gitignore                  # 指定 Git 忽略的文件
├── .gitmodules                 # 定义子模块
├── CONTRIBUTING.md             # 贡献指南
├── LICENSE.txt                 # Apache-2.0 许可证文件
├── README.md                   # 项目自述文件
├── init.bat                    # Windows 系统初始化脚本
├── init.sh                     # Unix/Linux 系统初始化脚本
├── protocols/                  # 额外的 protobuf 文件
├── tutorials/                  # 教程 Markdown 文件
├── exporter/                   # Fusion 导出器
├── fission/                    # 核心网页应用
├── installer/                  # Fusion 导出器安装程序
└── jolt/                       # Jolt 物理引擎子模块

• .github/：包含 GitHub 的工作流和模板等。
• .gitignore：列出项目中的文件和目录，告诉 Git 忽略它们。
• .gitmodules：用于定义子模块。
• CONTRIBUTING.md：提供贡献项目的方式和指南。
• LICENSE.txt：项目的许可证文件，采用 Apache-2.0 许可。
• README.md：项目的详细介绍。
• init.bat 和 init.sh：用于初始化项目的脚本，分别对应 Windows 和 Unix/Linux 系统。
• protocols/：包含项目使用的额外 protobuf 文件。
• tutorials/：包含项目的教程 Markdown 文件。
• exporter/：Fusion 导出器，用于将 Fusion CAD 设计导出为仿真器可以读取的格式。
• fission/：核心网页应用，是仿真器的主体部分。
• installer/：Fusion 导出器安装程序。
• jolt/：Jolt 物理引擎，仿真器中用于物理模拟的子模块。

2. 项目的启动文件介绍

项目的启动文件根据操作系统的不同而有所不同：

• 对于 Windows 用户，使用 init.bat 脚本进行初始化。
• 对于 Unix/Linux 用户，使用 init.sh 脚本进行初始化。

这些脚本会进行必要的设置，确保所有依赖正确安装，并准备项目环境。

3. 项目的配置文件介绍

项目的配置文件主要分布在几个关键目录和文件中：

• README.md：这是项目的主自述文件，包含了项目的描述、目标、使用方法以及如何贡献等信息。
• .gitignore：配置 Git 忽略文件，以避免将不必要的文件提交到仓库。
• CONTRIBUTING.md：提供贡献者指南，解释如何提交问题和 pull request，以及贡献的流程和规范。
• 其他配置文件可能位于项目的不同子模块中，如 fission/、exporter/、installer/ 和 jolt/，这些子模块可能会有自己的配置文件，具体取决于它们的实际需求和功能。

请确保仔细阅读每个模块的 README.md 文件，以了解如何正确配置和使用这些模块。