diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..8a3df731806b86cf3e8797c8516be56b78cf36fe --- /dev/null +++ b/README.en.md @@ -0,0 +1,50 @@ +# DevBell for Codex + +This project provides configuration, prompts, and a quick start guide for deep integration between DevBell and Codex. + +## Overview + +DevBell is a development assistant tool that achieves collaborative work with Codex through a state synchronization mechanism. This repository contains complete integration configuration, new project deployment prompts, and detailed quick start documentation. + +## Project Files + +| File | Description | +|------|------| +| `AGENTS.md` | DevBell state synchronization connection requirements and behavioral guidelines | +| `devbell-codex-quickstart.md` | DevBell + Codex New Project Quick Start Guide (English) | +| `devbell-codex-quickstart.zh_CN.md` | DevBell + Codex New Project Quick Start Guide (Chinese) | +| `devbell-deploy-new-project-prompt.md` | New Project Deployment Prompt | +| `devbell-new-project-bridge-installed-prompt.md` | New Project Prompt When Bridge is Installed (English) | +| `devbell-new-project-bridge-installed-prompt.zh_CN.md` | New Project Prompt When Bridge is Installed (Chinese) | +| `devbell-new-project-bridge-not-installed-prompt.md` | New Project Prompt When Bridge is Not Installed (English) | + +## Quick Start + +Please refer to [devbell-codex-quickstart.md](devbell-codex-quickstart.md) or its Chinese version [devbell-codex-quickstart.zh_CN.md](devbell-codex-quickstart.zh_CN.md) for detailed installation and configuration steps. + +### Basic Workflow + +1. **Select Installation Path** - Determine the project installation directory +2. **Verify Resident Bridge** - Confirm the Bridge service is running normally +3. **Confirm AGENTS.md** - Ensure the project contains necessary configuration files +4. **Start Codex Task** - Begin using DevBell state synchronization +5. **Test Interaction Prompts** - Verify human-machine interaction functionality + +## Key Features + +- **State Synchronization** - Real-time state synchronization between DevBell and Codex +- **Human-Machine Interaction** - Supports prompts and responses requiring human participation +- **Multi-language Support** - Provides documentation and prompts in English and Chinese + +## Troubleshooting + +If you encounter issues, please refer to the "Troubleshooting" section in the Quick Start documentation. + +## Related Links + +- [DevBell Official Documentation](#) (Please replace with actual link) +- [Codex Official Documentation](#) (Please replace with actual link) + +--- + +*This project is contributed by the community. Feel free to submit Issues and Pull Requests.* \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..eb900f9682f69c11a535d75b7170a328b5aa6323 --- /dev/null +++ b/README.md @@ -0,0 +1,50 @@ +# DevBell for Codex + +本项目提供 DevBell 与 Codex 深度集成的配置、提示词和快速上手指南。 + +## 概述 + +DevBell 是一个开发辅助工具,通过状态同步机制与 Codex 实现协同工作。本仓库包含完整的集成配置、新项目部署提示词以及详细的快速上手文档。 + +## 项目文件 + +| 文件 | 说明 | +|------|------| +| `AGENTS.md` | DevBell 状态同步的连接要求和行为规范 | +| `devbell-codex-quickstart.md` | DevBell + Codex 新项目快速上手指南(英文) | +| `devbell-codex-quickstart.zh_CN.md` | DevBell + Codex 新项目快速上手指南(中文) | +| `devbell-deploy-new-project-prompt.md` | 新项目部署提示词 | +| `devbell-new-project-bridge-installed-prompt.md` | 桥接已安装时的新项目提示词(英文) | +| `devbell-new-project-bridge-installed-prompt.zh_CN.md` | 桥接已安装时的新项目提示词(中文) | +| `devbell-new-project-bridge-not-installed-prompt.md` | 桥接未安装时的新项目提示词(英文) | + +## 快速开始 + +请参阅 [devbell-codex-quickstart.md](devbell-codex-quickstart.md) 或其中文版 [devbell-codex-quickstart.zh_CN.md](devbell-codex-quickstart.zh_CN.md) 获取详细的安装和配置步骤。 + +### 基本流程 + +1. **选择安装路径** - 确定项目的安装目录 +2. **验证常驻桥接** - 确认 Bridge 服务正常运行 +3. **确认 AGENTS.md** - 确保项目包含必要的配置文件 +4. **启动 Codex 任务** - 开始使用 DevBell 状态同步 +5. **测试交互提示** - 验证人机交互功能 + +## 主要功能 + +- **状态同步** - DevBell 与 Codex 之间的实时状态同步 +- **人机交互** - 支持需要人类参与的提示和响应 +- **多语言支持** - 提供英文和中文文档及提示词 + +## 故障排除 + +如遇到问题,请参考快速上手文档中的「故障排除」章节。 + +## 相关链接 + +- [DevBell 官方文档](#](请替换为实际链接) +- [Codex 官方文档](#](请替换为实际链接) + +--- + +*本项目由社区贡献,欢迎提交 Issue 和 Pull Request。* \ No newline at end of file