docs: 更新 README 和开发文档
This commit is contained in:
45
README.md
45
README.md
@@ -0,0 +1,45 @@
|
||||
# Rune
|
||||
|
||||
基于 SDD(Spec-Driven Development)的命令行工具,通过向 AI 开发工具注入 command 和 skill,驱动结构化编码流程。
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
bunx rune init opencode
|
||||
```
|
||||
|
||||
## 使用
|
||||
|
||||
### 初始化
|
||||
|
||||
```bash
|
||||
bunx rune init opencode
|
||||
```
|
||||
|
||||
会在项目中创建:
|
||||
- `.rune/` 目录(配置、变更文档、归档)
|
||||
- `.opencode/commands/` 和 `.opencode/skills/`(注入的 AI 工具配置)
|
||||
|
||||
### SDD 流程
|
||||
|
||||
1. `/discuss` — 自由讨论需求
|
||||
2. `/plan <变更名>` — 生成设计文档和任务列表
|
||||
3. `/build <变更名>` — 按任务顺序编码实现
|
||||
4. `/archive <变更名>` — 归档并清理
|
||||
|
||||
### 状态查看
|
||||
|
||||
```bash
|
||||
rune status
|
||||
```
|
||||
|
||||
### 自定义配置
|
||||
|
||||
编辑 `.rune/config.yaml` 自定义提示词和文档模板。未配置的阶段使用内置默认配置。
|
||||
|
||||
## 开发
|
||||
|
||||
```bash
|
||||
bun test # 运行测试
|
||||
bun src/cli.ts # 运行 CLI
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user