OpenHW Group 项目使用指南

OpenHW Group 项目使用指南

1. 项目目录结构及介绍

OpenHW Group 的 programs 项目包含了多个子目录，每个目录都对应一个特定的项目或组件。以下是对主要目录的简要介绍：

• TWG：技术工作小组（Technical Working Group）的会议记录和演示文稿。
• TG：任务小组（Task Group）的月度报告、会议记录和演示文稿。包括核心任务组、硬件任务组、验证任务组等。
• OpenHW-Project-Descriptions-and-Plans：包含每个 OpenHW 项目的目录，每个目录包含项目的门控材料，如项目概念、项目启动、计划批准和项目冻结等。
• OpenHW-dashboard：包含一个 markdown 文件，其中包含 OpenHW 的项目仪表板信息，该文件与 OpenHW 网站链接。
• process：包含 OpenHW 的流程和模板文件，如门控模板和RTL冻结模板。
• attendance-tracking：包含所有 OpenHW 会议的出勤跟踪。

2. 项目的启动文件介绍

在 programs 项目中，并没有一个特定的“启动文件”。项目的使用通常是从阅读 README.md 文件开始的，它提供了项目的基本信息和如何开始使用项目的一般指导。

• README.md：项目的自述文件，描述了项目的目的、功能、如何使用和参与贡献的方法。

3. 项目的配置文件介绍

programs 项目中包含了一些配置文件，这些文件用于管理项目的工作流程和规范。

• CODE_OF_CONDUCT.md：项目的行为准则，规定了参与者的行为规范。
• CONTRIBUTING.md：贡献指南，提供了如何为项目做贡献的详细步骤和最佳实践。
• LICENSE.md：项目许可证文件，说明了项目的版权和使用条款。

这些配置文件是项目的基础组成部分，确保了项目的健康发展和社区的和谐交流。在使用项目之前，建议仔细阅读这些文件，以了解项目的规则和要求。