XOD 开源项目安装与使用指南

XOD 是一个专为微控制器设计的视觉编程语言。本指南将帮助您了解其基本结构、关键文件以及如何启动和配置该项目。

1. 项目目录结构及介绍

XOD项目遵循Lerna的单体仓库管理方式，其主要目录结构如下：

• packages/：包含大部分源代码。每个子目录代表一个特定的功能包或库，通过阅读各子目录下的README.md可以了解到具体用途。
• tools/：存放辅助开发过程的脚本工具，用于构建流程的支持和日常维护任务。
• workspace/：包含XOD标准库、示例项目和端到端测试案例。这是存放核心逻辑和默认项目模板的地方。

2. 项目的启动文件介绍

XOD项目的主要运行入口依赖于Node.js和Yarn作为构建和执行环境。启动分为两个主要场景：

• 桌面IDE: 若要启动XOD的桌面版本，您需要执行以下命令：

  yarn start:electron
  

• 浏览器版IDE: 若希望在本地开发环境中运行基于浏览器的IDE，则应使用：

  yarn dev:browser
  

  这将在localhost的8080端口上提供服务。

3. 项目的配置文件介绍

主要配置文件

• .gitignore 和 npmignore: 定义了在提交或发布时不纳入版本控制的文件类型。

• lerna.json : Lerna的配置文件，管理着单体仓库内的多个npm包，定义了版本同步等行为。

• package.json: 核心配置文件，包含了项目的基本信息、依赖项、脚本命令等。是项目启动和自动化任务的起点。

• yarn.lock: 确保项目中所有依赖项的具体版本一致，避免“依赖地狱”。

• editorconfig, .eslintignore, .eslintrc.js, prettierignore, prettierrc.json: 这些文件共同确保代码风格的一致性，通过编辑器规则和代码美化工具进行实施。

• CHANGELOG.md, CONTRIBUTING.md, LICENSE.txt: 分别记录软件变更日志、贡献者指导原则以及使用的许可证（AGPL-3.0）。

为了完整体验XOD，您还需关注各包内部的说明文件，比如packages/下的每个子包可能都有自己的配置和说明文档，这对于深入理解和定制功能至关重要。

通过以上步骤和了解，您可以开始探索并利用XOD进行微控制器的可视化编程了。记得查看官方文档(https://xod.io/docs/)以获取更详细的教学和最佳实践。