Skip to content

Commit 4bee710

Browse files
committed
docs: 完善README文档,添加项目截图和详细介绍
- 添加三个核心页面的高质量截图(首页、提示词构建、Profile管理) - 更新GitHub Pages部署地址为正确的URL - 完善项目简介,突出核心特性和价值 - 添加详细的功能介绍:智能提示词构建、文件处理、Profile管理、历史记录 - 增加技术栈说明和使用指南 - 优化文档结构,提升可读性和专业性 - 添加社区交流信息和快速开始指南
1 parent 5348d5a commit 4bee710

File tree

4 files changed

+116
-3
lines changed

4 files changed

+116
-3
lines changed

README.assets/homepage-screenshot.png

93.5 KB
Loading
56.5 KB
Loading
81.3 KB
Loading

README.md

Lines changed: 116 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,122 @@
11
# AI 编程提示词构建工具
22

3-
在线部署:https://llm-sec.github.io/ai-coding-prompt-builder
3+
🚀 **在线体验地址:[https://ai-coding-labs.github.io/ai-coding-prompt-builder/](https://ai-coding-labs.github.io/ai-coding-prompt-builder/)**
44

5+
## 📖 项目简介
56

7+
AI编程提示词构建工具是一个专为开发者设计的智能化平台,旨在帮助用户快速构建高质量的AI编程提示词。通过直观的界面和强大的功能,让您轻松创建适合不同编程场景的AI助手配置。
68

7-
![image-20250217045226044](./README.assets/image-20250217045226044.png)
9+
## ✨ 核心特性
810

9-
![image-20250217045235401](./README.assets/image-20250217045235401.png)
11+
### 🎯 智能提示词构建
12+
- **多场景模板**:内置通用编程、代码审查、问题诊断、架构设计等专业模板
13+
- **自定义配置**:支持角色信息、规则内容、输出格式的个性化定制
14+
- **实时预览**:即时查看提示词效果,支持Token计数
15+
16+
### 📁 强大的文件处理能力
17+
- **多格式支持**:支持所有主流编程语言文件(.js/.ts/.py/.java/.go/.rs等)
18+
- **智能识别**:自动识别非标准扩展名的代码文件
19+
- **批量上传**:支持文件夹拖拽和多文件批量处理
20+
- **PDF支持**:自动将PDF文档转换为Markdown格式
21+
22+
### 🔧 Profile管理系统
23+
- **配置保存**:将常用的提示词配置保存为Profile
24+
- **分类管理**:按开发编程、代码审查、调试修复等分类组织
25+
- **快速切换**:一键加载不同场景的专业配置
26+
- **导入导出**:支持配置的备份和分享
27+
28+
### 📚 历史记录功能
29+
- **构建历史**:自动保存每次提示词构建记录
30+
- **快速恢复**:从历史记录中快速恢复之前的配置
31+
- **版本管理**:追踪提示词的演进过程
32+
33+
## 🖼️ 界面预览
34+
35+
### 首页 - 产品介绍
36+
![首页截图](./README.assets/homepage-screenshot.png)
37+
38+
### 提示词构建页面 - 核心功能
39+
![提示词构建页面](./README.assets/prompt-builder-screenshot.png)
40+
41+
### Profile管理页面 - 配置管理
42+
![Profile管理页面](./README.assets/profiles-page-screenshot.png)
43+
44+
## 🚀 快速开始
45+
46+
### 在线使用
47+
直接访问:[https://ai-coding-labs.github.io/ai-coding-prompt-builder/](https://ai-coding-labs.github.io/ai-coding-prompt-builder/)
48+
49+
### 本地部署
50+
51+
1. **克隆项目**
52+
```bash
53+
git clone https://github.com/ai-coding-labs/ai-coding-prompt-builder.git
54+
cd ai-coding-prompt-builder
55+
```
56+
57+
2. **安装依赖**
58+
```bash
59+
npm install
60+
```
61+
62+
3. **启动开发服务器**
63+
```bash
64+
npm run dev
65+
# 或使用便捷脚本
66+
./start.sh
67+
```
68+
69+
4. **构建生产版本**
70+
```bash
71+
npm run build
72+
```
73+
74+
## 🛠️ 技术栈
75+
76+
- **前端框架**:React 18 + TypeScript
77+
- **构建工具**:Vite
78+
- **UI组件库**:Material-UI (MUI)
79+
- **状态管理**:React Hooks
80+
- **文件处理**:PDF.js
81+
- **部署平台**:GitHub Pages
82+
83+
## 📋 使用指南
84+
85+
### 1. 选择或创建Profile
86+
- 从预设的专业模板中选择适合的Profile
87+
- 或创建自定义的提示词配置
88+
89+
### 2. 配置提示词内容
90+
- **角色信息**:定义AI助手的专业背景和能力
91+
- **规则内容**:设置具体的行为规范和约束
92+
- **输出格式**:指定期望的回答结构和样式
93+
94+
### 3. 上传参考文件
95+
- 拖拽代码文件或文件夹到上传区域
96+
- 支持PDF文档自动转换
97+
- 设置文件过滤条件
98+
99+
### 4. 生成提示词
100+
- 点击"构造提示词"按钮
101+
- 自动复制到剪贴板
102+
- 可保存到历史记录
103+
104+
## 🤝 社区交流
105+
106+
### 微信交流群
107+
扫码添加好友,备注"大模型"申请入群
108+
109+
### QQ交流群
110+
[一键加群](https://qm.qq.com/q/pYBa99j1e2)
111+
112+
## 📄 开源协议
113+
114+
本项目采用 MIT 协议开源,详见 [LICENSE](LICENSE) 文件。
115+
116+
## 🙏 致谢
117+
118+
感谢所有为这个项目贡献代码和建议的开发者们!
119+
120+
---
121+
122+
🚀 **立即体验:[https://ai-coding-labs.github.io/ai-coding-prompt-builder/](https://ai-coding-labs.github.io/ai-coding-prompt-builder/)**

0 commit comments

Comments
 (0)