Skip to content

Commit 2d2a567

Browse files
committed
新增描述文件
1 parent 13d53a8 commit 2d2a567

1 file changed

Lines changed: 125 additions & 75 deletions

File tree

README.md

Lines changed: 125 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,132 @@
1-
# Prompt Tools
1+
# Prompt Tools: 你的专属提示词管家
22

3-
一个基于 Tauri 的桌面应用程序。
3+
<p align="center">
4+
<img src="./src-tauri/icons/logo.png" alt="Prompt Tools Logo" width="150">
5+
</p>
46

5-
## 开发
7+
<p align="center">
8+
<strong>一款开源、免费的桌面神器,旨在彻底简化你的 Prompt 管理工作流程。</strong>
9+
<br />
10+
<a href="https://github.com/jwangkun/Prompt-Tools/releases/latest"><strong>下载最新版本 »</strong></a>
11+
<br />
12+
<br />
13+
<a href="https://github.com/jwangkun/Prompt-Tools/issues">报告 Bug</a>
14+
·
15+
<a href="https://github.com/jwangkun/Prompt-Tools/issues">请求功能</a>
16+
</p>
617

7-
```bash
8-
# 安装依赖
9-
npm install
18+
---
19+
20+
嘿,各位 AI 玩家和效率达人!在这个 AI 浪潮席卷一切的时代,无论是与 ChatGPT 谈天说地,还是让 Midjourney 挥洒创意,我们都离不开一个核心的东西——**提示词(Prompt)**
21+
22+
## 你的“咒语”,决定了 AI 的“魔力”
23+
24+
我们可以把 Prompt 想象成与 AI 沟通的“魔法咒语”。一句精心设计的咒语,能让 AI 精准地理解你的意图,产出令人惊艳的文案、代码、图片或解决方案。随着我们使用 AI 的频率越来越高,手上积累的“神级咒语”也越来越多。这些都是我们智慧和经验的结晶,是宝贵的数字资产。
25+
26+
但问题也随之而来...
27+
28+
## 你的 Prompt,是否也“无家可归”?
29+
30+
当你的“咒语书”越来越厚,你是否也遇到了这些令人头疼的管理痛点?
31+
32+
- 🤯 **杂乱无章**:Prompt 散落在备忘录、微信收藏、TXT 文档、Excel 表格里,像一盘散沙。
33+
- 🔍 **查找困难**:急用时想不起某个关键 Prompt 放在了哪里,只能凭记忆在各个角落疯狂翻找,效率低下。
34+
- 📂 **分类不明**:没有统一的分类和标签体系,无法系统性地整理和优化你的 Prompt 库。
35+
- 😩 **同步不便**:在公司电脑上收藏的 Prompt,回到家里的电脑就用不了,只能通过聊天软件传来传去。
36+
37+
这些痛点不仅浪费了我们宝贵的时间,更限制了我们利用 AI 提升生产力的上限。是时候给你的 Prompt 安个家了!
38+
39+
---
40+
41+
## Prompt Tools:你的专属提示词管家
42+
43+
**Prompt Tools** 是一款强大的桌面应用程序,旨在彻底简化你的 Prompt 管理工作流程。它基于 Tauri 框架构建,为你提供快速、安全和跨平台的极致体验。
44+
45+
![应用截图](./image.png)
46+
47+
### ✨ 核心功能特性
48+
49+
* ✍️ **Prompt 管理**: 像管理笔记一样,轻松创建、编辑、搜索和组织你的所有 Prompt。
50+
* 💻 **跨平台运行**: 目前支持 macOS,未来将支持 Windows 和 Linux,提供原生般流畅的体验。
51+
* 🚀 **轻量与高效**: 基于 Rust 和 Web 前沿技术构建,启动飞快,占用资源少,告别卡顿。
52+
* 🔐 **本地优先,安全私密**: 你的所有数据都存储在本地计算机上,无需担心隐私泄露,数据由你一手掌控。
53+
54+
### 📥 下载与安装
55+
56+
您可以直接从 **[GitHub Releases](https://github.com/jwangkun/Prompt-Tools/releases/latest)** 页面下载最新的预编译版本。目前仅提供 macOS (Apple Silicon) 版本。
57+
58+
---
59+
60+
## 👨‍💻 面向开发者
61+
62+
对于喜欢钻研技术的同学,Prompt Tools 的技术栈同样令人兴奋。作为一款开源项目,你可以轻松地在本地运行或构建它。
63+
64+
### 🛠️ 技术栈
1065

11-
# 开发模式
12-
npm run tauri:dev
66+
* **前端:** TypeScript, Vite, React
67+
* **后端与核心:** Rust, Tauri
68+
* **数据库:** SQLite
69+
* **包管理器:** pnpm
1370

14-
# 构建
15-
npm run tauri:build
71+
### 📋 环境准备
72+
73+
在开始之前,请确保你的系统上已安装以下软件:
74+
75+
* [Node.js](https://nodejs.org/) (推荐 v18 或更高版本)
76+
* [pnpm](https://pnpm.io/installation)
77+
* [Rust & Cargo](https://www.rust-lang.org/tools/install)
78+
* [Tauri 开发环境依赖](https://tauri.app/v2/guides/getting-started/prerequisites)
79+
80+
### 🚀 快速上手
81+
82+
1. **克隆仓库:**
83+
```bash
84+
git clone https://github.com/jwangkun/Prompt-Tools.git
85+
cd Prompt-Tools
86+
```
87+
88+
2. **安装依赖:**
89+
```bash
90+
pnpm install
91+
```
92+
93+
3. **以开发模式运行:**
94+
```bash
95+
pnpm tauri:dev
96+
```
97+
98+
### 📦 构建应用
99+
100+
如果你想打包成可执行的应用程序,只需运行:
101+
102+
```bash
103+
pnpm tauri:build
16104
```
17105

18-
## GitHub Actions 工作流
19-
20-
本项目包含三个 GitHub Actions 工作流:
21-
22-
### 1. 自动发布 (release.yml)
23-
- **触发条件**: 推送 `v*` 标签时自动触发
24-
- **支持平台**:
25-
- Linux (Ubuntu 22.04) - AppImage, DEB, RPM
26-
- Windows (Windows 2022) - EXE, MSI
27-
- macOS Intel (macOS 13) - DMG, APP
28-
- macOS Apple Silicon (macOS 14) - DMG, APP
29-
- **使用方法**:
30-
```bash
31-
git tag v1.0.0
32-
git push origin v1.0.0
33-
```
34-
35-
### 2. CI 测试 (ci.yml)
36-
- **触发条件**:
37-
- 推送到 `main``develop` 分支
38-
- 创建 Pull Request 到 `main` 分支
39-
- 手动触发
40-
- **功能**:
41-
- 前端代码检查(类型检查、构建)
42-
- 后端代码检查(cargo check)
43-
- 可选的多平台构建测试
44-
45-
### 3. 手动发布 (manual-release.yml)
46-
- **触发条件**: 手动触发
47-
- **功能**:
48-
- 可选择特定平台构建
49-
- 自定义版本号
50-
- 可标记为预发布版本
51-
52-
## 发布流程
53-
54-
### 自动发布
55-
1. 确保代码已提交并推送到主分支
56-
2. 创建并推送标签:
57-
```bash
58-
git tag v1.0.0
59-
git push origin v1.0.0
60-
```
61-
3. GitHub Actions 将自动构建所有平台并创建 Release
62-
63-
### 手动发布
64-
1. 进入 GitHub 仓库的 Actions 页面
65-
2. 选择 "Manual Release" 工作流
66-
3. 点击 "Run workflow"
67-
4. 填写版本号和选择平台
68-
5. 运行工作流
69-
70-
## 构建产物
71-
72-
- **Linux**: `.AppImage`, `.deb`, `.rpm`
73-
- **Windows**: `.exe`, `.msi`
74-
- **macOS**: `.dmg`, `.app`
75-
76-
## 注意事项
77-
78-
1. 首次使用需要在 GitHub 仓库设置中启用 Actions
79-
2. 如需代码签名,请在仓库 Secrets 中配置:
80-
- `TAURI_PRIVATE_KEY`: Tauri 私钥
81-
- `TAURI_KEY_PASSWORD`: 私钥密码
82-
3. macOS 构建会生成 Intel 和 Apple Silicon 两个版本
106+
可执行文件将位于 `src-tauri/target/release/` 目录中,而完整的安装包则在 `src-tauri/target/release/bundle/` 目录下。
107+
108+
---
109+
110+
## 🤝 欢迎共建
111+
112+
Prompt Tools 是一个开放的开源项目,欢迎各种形式的贡献!如果你有任何绝妙的想法或建议,都可以通过提交 Pull Request 来参与项目共建。
113+
114+
1. Fork 本项目
115+
2. 创建您的新分支 (`git checkout -b feature/AmazingFeature`)
116+
3. 提交您的更改 (`git commit -m 'Add some AmazingFeature'`)
117+
4. 将分支推送到远程仓库 (`git push origin feature/AmazingFeature`)
118+
5. 开启一个 Pull Request
119+
120+
## 📄 许可证
121+
122+
该项目采用 [MIT 许可证](LICENSE)。
123+
124+
---
125+
126+
## 写在最后
127+
128+
Prompt Tools 不仅仅是一个工具,更是一种高效的工作方式。它将帮助你把零散的智慧火花汇集成一座强大的、随用随取的知识库。
129+
130+
如果你也曾为 Prompt 管理而烦恼,那么这款免费、开源、安全的桌面工具绝对值得一试!
131+
132+
**[➡️ 点击这里,直达项目仓库,给作者一个 Star 吧!](https://github.com/jwangkun/Prompt-Tools)**

0 commit comments

Comments
 (0)