Skip to content

Commit 9fcd56e

Browse files
committed
增加使用说明
1 parent 829e3c1 commit 9fcd56e

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CodeReDesign
22

3-
**CodeReDesign** 是一个 VSCode 插件,旨在帮助开发者更高效地进行代码重构和重新设计。通过提供文件选择、代码合并、CVB 文件生成、API 调用等功能,CodeReDesign 让代码重构变得更加简单和流畅。
3+
**CodeReDesign** 是一个 VSCode 插件,旨在配合DeepSeek API。帮助开发者更高效地进行代码重构和重新设计。通过提供文件选择、代码合并文件生成、SeepSeek API 上传和接收,本地代码应用,CodeReDesign 让代码重构变得更加简单和流畅。
44

55
---
66

@@ -10,4 +10,31 @@
1010
- **CVB 文件生成**:将选中的文件合并为 CVB 格式文件,支持编码检测和转换(如 GBK 转 UTF-8)。
1111
- **API 调用**:上传 CVB 文件并调用 DeepSeek API,获取重构建议。
1212
- **版本管理**:支持 CVB 文件的解析、应用和回滚。
13-
- **多语言支持**:支持 C++、Python、Lua、TypeScript 等多种编程语言。
13+
- **多语言支持**:支持 C++、Python、Lua、TypeScript 等多种编程语言。
14+
15+
## 使用方法
16+
17+
#### 使用前需要先设置DeepSeek API 的Key
18+
File -> Preferences -> Settings(文件 -> 首选项 -> 设置)
19+
搜索 coderedesign
20+
在 Deep Seek Api Key(DeepSeek API 密钥)
21+
里填写你在DeepSeek哪里申请到的Key
22+
23+
#### 指令:
24+
ctrl + shift + p 打开指令菜单(Command Palette),有以下几个指令可用
25+
26+
1. codeReDesign.generateCvb(生成 CVB 文件)
27+
打包需要重构的代码为 CVB 格式
28+
选中你需要的文件,回车
29+
给这些文件取一个版本名,比如输入 "准备重构多进程-初始版本"
30+
会在本地 .CodeReDesignWorkSpace 目录下生成一个 时间戳+版本名.cvb 的文件,可以使用 markdown 格式查看
31+
32+
2. codeReDesign.uploadCvb(上传 CVB 文件)
33+
选择一个本地已经打包好的 CVB 格式文件,上传到 DeepSeek
34+
输入你希望重构的提示词,比如 "把这些代码里的多进程重构为多线程,注意要把进程间通讯的标准输出输入句柄改为无锁队列"
35+
然后 DeepSeek 就会开始帮你重构,你可以在输出框看到中间过程
36+
输出完毕,会在本地创建一个新的 CVB 格式文件
37+
38+
3. codeReDesign.applyCvb(应用 CVB 文件)
39+
如果查看后觉得没问题,可以用这个指令
40+
将这个 CVB 格式文件展开覆盖本地文件

0 commit comments

Comments
 (0)