开源项目使用教程：AI 提示和规则集

开源项目使用教程：AI 提示和规则集

1. 项目目录结构及介绍

本项目包含了用于辅助 AI 编码的工具提示和规则。以下是项目的目录结构及其说明：

• .cursor/: 存放 Cursor 项目的规则文件。
  • rules/: 规则文件存放目录。
• .github/: 存放 GitHub 相关的配置文件。
  • workflows/: GitHub 工作流文件存放目录。
• data/: 存放项目所需的数据文件。
• images/: 存放项目所需的图片文件。
• prompt-template/: 提示模板文件存放目录。
• prompts/: 提示文件存放目录，包含具体的 AI 提示。
• public/: 公共文件存放目录，通常用于存放静态文件。
• scripts/: 脚本文件存放目录。
• .gitignore: 指定 Git 忽略的文件列表。
• CONTRIBUTING.md: 为贡献者提供的指南。
• LICENSE: 项目的开源协议文件。
• README.md: 项目的说明文件。
• package-lock.json: 包依赖锁定文件。
• package.json: 包管理配置文件。

2. 项目的启动文件介绍

本项目不需要特定的启动文件。项目的使用依赖于将提示文件配置到相应的 AI 编码工具中。

3. 项目的配置文件介绍

本项目的配置文件主要与不同 AI 编码工具的集成相关。以下是一些主要配置文件的介绍：

• .cursor/rules/cursorrules.mdc: Cursor 规则文件，用于定义 Cursor 工具的编码标准。
• .github/copilot-instructions.md: GitHub Copilot 指令文件，以 Markdown 格式定义 Copilot 的行为指南。
• .zed/settings.json: Zed 配置文件，用于设置 Zed 工具的项目特定配置。
• .windsurfrules: Windsurf 规则文件，用于定义 Windsurf 工具的行为。

根据您的项目需求，您可以将这些配置文件添加到您的项目中，并按照各自工具的指南进行调整，以确保 AI 工具按照您的项目标准和要求进行操作。