概述
README 引导工作流是一个初级难度的工作流。为新仓库创建包含项目名、设置说明和用法的最小 README。该工作流的目标是：Provide enough documentation for a new contributor to clone and run the project within 10 minutes.
环境准备
执行本工作流需要以下环境：A new Git repository；A project with a defined build and run process；A text editor。请确保在开始前准备好所有必需的工具和资源，以避免中途因环境问题中断。
执行步骤
本工作流包含4个步骤。步骤1：Create README.md——Create a README.md file with the project name as the top-level heading. 步骤2：Add setup section——Document the clone, install, and run commands needed to start the project. 步骤3：Add usage section——Add a usage section with at least one example command or code snippet. 步骤4：Verify by following——Follow the README from scratch in a clean environment to verify accuracy.
验证与清理
预期结果：A new contributor can clone the repository and have the project running by following the README alone.。验证方法：Ask someone unfamiliar with the project to follow the README and confirm they can run it successfully.。清理操作：No cleanup needed.。estimatedMinutes 为 30 分钟。
代码示例
# My Project
A short description.
## Setup