Skip to content

Commit 9f64fbe

Browse files
committed
chore: update reamde
1 parent fc6505f commit 9f64fbe

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
## 简介
55
ShitCodify是一个能够将正常、易读、易维护的代码转换为难以理解、难以维护但仍然能够正常工作的"屎山代码"的工具。
6-
它利用大型语言模型(如GPT-4)来分析你的代码,并应用各种"反模式"和不良实践来降低代码的可读性和可维护性,同时保持代码的功能不变。
6+
它利用大型语言模型(如GPT-4, Claude)来分析你的代码,并应用各种"反模式"和不良实践来降低代码的可读性和可维护性,同时保持代码的功能不变。
77

88
## 为什么需要这个工具?
99
- 工作保障计划: 确保你的代码像谜题一样存在, 提升你在公司不可替代的地位
@@ -13,29 +13,33 @@ ShitCodify是一个能够将正常、易读、易维护的代码转换为难以
1313
- ...
1414

1515
## 特性
16-
- 支持多种编程语言(Rust、Python、JavaScript、Java、C++、Go、Ocaml等)
16+
- 支持多种编程语言(Rust、Python、JavaScript、Java、C++、Go等)
17+
- 支持多种开发框架(Django, Flask, Spring-Boot, React等)
1718
- 能确保代码功能不变,但使其难以阅读和维护
1819
- 应用语言特定的"反模式"和不良实践
1920
- 提供命令行界面,方便集成到工作流程中
2021
- 可配置的"屎山生成策略"
22+
- 支持根据配置生成.cursorrules
2123
- 支持单个文件和代码片段转换
2224
- 支持工程目录的转换 (todo)
2325
- 支持AI Agent交互模式,方便快速测试 (todo)
2426

2527
## 如何使用?
2628
当前 ShitCodify 还不支持像 cursor, trae 那样的 AI Agent 模式, 现在的实现仅仅只是通过codebase生成一段Prompt。
27-
直接访问 https://stepfenshawn.github.io/ShitCodify/#/ 生成 Prompt 后将其复制给大模型使用
29+
直接访问 https://stepfenshawn.github.io/ShitCodify/#/ 生成 Prompt 后将其复制给大模型使用:
2830
![截图](img/screenshot3.png)
2931

3032

3133
## "屎山"程度配置
3234
可以根据需要自定义"屎山"程度:
33-
![配置示例](img/screenshot1.png)
35+
![配置示例](img/screenshot1.png)
3436
自定义跳转到的大模型网页:
35-
![配置示例](img/screenshot2.png)
36-
示例:
37+
![配置示例](img/screenshot2.png)
38+
39+
## 使用示例:
40+
一段十分规范的Rust代码:
3741
![正常代码](img/example1.png)
38-
通过gpt-4o转化后:
42+
通过gpt-4o转化成屎山后:
3943
![屎山代码](img/shit1.png)
4044
## Build
4145
```sh

0 commit comments

Comments
 (0)