whai/cherry-studio
1
1
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

feat: update feature list and documentation for improved user understanding

Browse Source
This commit is contained in:
kangfenmao 2024-10-29 16:12:16 +08:00
parent 9ac35ae3d8
commit 6d6788eeb2
3 changed files with 209 additions and 79 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
README.md
View File

@ -21,25 +21,47 @@ Cherry Studio is a desktop client that supports for multiple LLM providers, avai
![](https://github.com/user-attachments/assets/8576863a-f632-4776-bc12-657eeced9da3) ![](https://github.com/user-attachments/assets/8576863a-f632-4776-bc12-657eeced9da3)
![](https://github.com/user-attachments/assets/790790d7-b462-48dd-bde1-91c1697a4648) ![](https://github.com/user-attachments/assets/790790d7-b462-48dd-bde1-91c1697a4648)
# 🌟 Features # 🌟 Key Features
<div align="center"> 1. **Diverse LLM Provider Support**:
<a href="https://www.producthunt.com/posts/cherry-studio?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cherry&#0045;studio" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=496640&theme=light" alt="Cherry&#0032;Studio - AI&#0032;Chatbots&#0044;&#0032;AI&#0032;Desktop&#0032;Client | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
</div>
1. Support for Multiple LLM Providers. - ☁️ Major LLM Cloud Services: OpenAI, Gemini, Anthropic, and more
2. Allows creation of multiple Assistants. - 🔗 AI Web Service Integration: Claude, Peplexity, Poe, and others
3. Enables creation of multiple topics. - 💻 Local Model Support with Ollama
4. Allows using multiple models to answer questions in the same conversation.
5. Supports drag-and-drop sorting. 2. **AI Assistants & Conversations**:
6. Code highlighting.
7. Mermaid chart - 📚 300+ Pre-configured AI Assistants
- 🤖 Custom Assistant Creation
- 💬 Multi-model Simultaneous Conversations
3. **Document & Data Processing**:
- 📄 Support for Text, Images, Office, PDF, and more
- ☁️ WebDAV File Management and Backup
- 📊 Mermaid Chart Visualization
- 💻 Code Syntax Highlighting
4. **Practical Tools Integration**:
- 🔍 Global Search Functionality
- 📝 Topic Management System
- 🔤 AI-powered Translation
- 🎯 Drag-and-drop Sorting
- 🔌 Mini Program Support
5. **Enhanced User Experience**:
- 🖥️ Cross-platform Support for Windows, Mac, and Linux
- 📦 Ready to Use, No Environment Setup Required
- 🎨 Light/Dark Themes and Transparent Window
- 📝 Complete Markdown Rendering
- 🤲 Easy Content Sharing
# 🖥️ Develop # 🖥️ Develop
## IDE Setup ## IDE Setup
[VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) [Cursor](https://www.cursor.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## Project Setup ## Project Setup
@ -68,24 +90,52 @@ $ yarn build:mac
$ yarn build:linux $ yarn build:linux
``` ```
# ⭐️ Star History # 🤝 Contributing
[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline) We welcome contributions to Cherry Studio! Here are some ways you can contribute:
1. **Contribute Code**: Develop new features or optimize existing code.
2. **Fix Bugs**: Submit fixes for any bugs you find.
3. **Maintain Issues**: Help manage GitHub issues.
4. **Product Design**: Participate in design discussions.
5. **Write Documentation**: Improve user manuals and guides.
6. **Community Engagement**: Join discussions and help users.
7. **Promote Usage**: Spread the word about Cherry Studio.
## Getting Started
1. **Fork the Repository**: Fork and clone it to your local machine.
2. **Create a Branch**: For your changes.
3. **Submit Changes**: Commit and push your changes.
4. **Open a Pull Request**: Describe your changes and reasons.
For more detailed guidelines, please refer to our [Contributing Guide](./CONTRIBUTING.md).
Thank you for your support and contributions!
# 🚀 Contributors # 🚀 Contributors
<a href="https://github.com/kangfenmao/cherry-studio/graphs/contributors"> <a href="https://github.com/kangfenmao/cherry-studio/graphs/contributors">
<img src="https://contrib.rocks/image?repo=kangfenmao/cherry-studio" /> <img src="https://contrib.rocks/image?repo=kangfenmao/cherry-studio" />
</a> </a>
<br /><br />
# Community # 🌐 Community
[Telegram](https://t.me/CherryStudioAI) [Telegram](https://t.me/CherryStudioAI) | [Email](mailto:kangfenmao@gmail.com) | [Twitter](https://x.com/kangfenmao)
# Sponsor # 📣 Product Hunt
<a href="https://www.producthunt.com/posts/cherry-studio?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cherry&#0045;studio" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=496640&theme=light" alt="Cherry&#0032;Studio - AI&#0032;Chatbots&#0044;&#0032;AI&#0032;Desktop&#0032;Client | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
# ☕ Sponsor
[Buy Me a Coffee](docs/sponsor.md) [Buy Me a Coffee](docs/sponsor.md)
# 📃 License # 📃 License
[LICENSE](./LICENSE) [LICENSE](./LICENSE)
# ⭐️ Star History
[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline)

79
docs/README.ja.md
View File

@ -21,25 +21,47 @@ Cherry Studioは、複数のLLMプロバイダーをサポートするデスク
![](https://github.com/user-attachments/assets/8576863a-f632-4776-bc12-657eeced9da3) ![](https://github.com/user-attachments/assets/8576863a-f632-4776-bc12-657eeced9da3)
![](https://github.com/user-attachments/assets/790790d7-b462-48dd-bde1-91c1697a4648) ![](https://github.com/user-attachments/assets/790790d7-b462-48dd-bde1-91c1697a4648)
# 🌟 特徴 # 🌟 主な機能
<div align="center"> 1. **多様な LLM サービス対応**：
<a href="https://www.producthunt.com/posts/cherry-studio?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cherry&#0045;studio" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=496640&theme=light" alt="Cherry&#0032;Studio - AI&#0032;Chatbots&#0044;&#0032;AI&#0032;Desktop&#0032;Client | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
</div>
1. 複数のLLMプロバイダーをサポート。 - ☁️ 主要な LLM クラウドサービス対応：OpenAI、Gemini、Anthropic など
2. 複数のアシスタントを作成可能。 - 🔗 AI Web サービス統合：Claude、Peplexity、Poe など
3. 複数のトピックを作成可能。 - 💻 Ollama によるローカルモデル実行対応
4. 同じ会話で複数のモデルを使用して質問に回答可能。
5. ドラッグアンドドロップでの並べ替えをサポート。 2. **AI アシスタントと対話**：
6. コードハイライト。
7. Mermaidチャート - 📚 300+ の事前設定済み AI アシスタント
- 🤖 カスタム AI アシスタントの作成
- 💬 複数モデルでの同時対話機能
3. **文書とデータ処理**：
- 📄 テキスト、画像、Office、PDF など多様な形式対応
- ☁️ WebDAV によるファイル管理とバックアップ
- 📊 Mermaid による図表作成
- 💻 コードハイライト機能
4. **実用的なツール統合**：
- 🔍 グローバル検索機能
- 📝 トピック管理システム
- 🔤 AI による翻訳機能
- 🎯 ドラッグ＆ドロップによる整理
- 🔌 ミニプログラム対応
5. **優れたユーザー体験**：
- 🖥️ Windows、Mac、Linux のクロスプラットフォーム対応
- 📦 環境構築不要ですぐに使用可能
- 🎨 ライト/ダークテーマと透明ウィンドウ対応
- 📝 完全な Markdown レンダリング
- 🤲 簡単な共有機能
# 🖥️ 開発 # 🖥️ 開発
## IDEの設定 ## IDEの設定
[VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) [Cursor](https://www.cursor.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## プロジェクトの設定 ## プロジェクトの設定
@ -68,9 +90,28 @@ $ yarn build:mac
$ yarn build:linux $ yarn build:linux
``` ```
# ⭐️ スター履歴 # 🤝 貢献
[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline) Cherry Studioへの貢献を歓迎します！以下の方法で貢献できます：
1. **コードの貢献**：新機能を開発するか、既存のコードを最適化します。
2. **バグの修正**：見つけたバグを修正します。
3. **問題の管理**：GitHubの問題を管理するのを手伝います。
4. **製品デザイン**：デザインの議論に参加します。
5. **ドキュメントの作成**：ユーザーマニュアルやガイドを改善します。
6. **コミュニティの参加**：ディスカッションに参加し、ユーザーを支援します。
7. **使用の促進**：Cherry Studioを広めます。
## 始め方
1. **リポジトリをフォーク**：フォークしてローカルマシンにクローンします。
2. **ブランチを作成**：変更のためのブランチを作成します。
3. **変更を提出**：変更をコミットしてプッシュします。
4. **プルリクエストを開く**：変更内容と理由を説明します。
詳細なガイドラインについては、[貢献ガイド](./CONTRIBUTING.md)をご覧ください。
ご支援と貢献に感謝します！
# 🚀 コントリビューター # 🚀 コントリビューター
@ -80,7 +121,11 @@ $ yarn build:linux
# コミュニティ # コミュニティ
[Telegram](https://t.me/CherryStudioAI) [Telegram](https://t.me/CherryStudioAI) | [Email](mailto:kangfenmao@gmail.com) | [Twitter](https://x.com/kangfenmao)
# 📣 プロダクトハント
<a href="https://www.producthunt.com/posts/cherry-studio?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cherry&#0045;studio" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=496640&theme=light" alt="Cherry&#0032;Studio - AI&#0032;Chatbots&#0044;&#0032;AI&#0032;Desktop&#0032;Client | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
# スポンサー # スポンサー
@ -89,3 +134,7 @@ $ yarn build:linux
# 📃 ライセンス # 📃 ライセンス
[LICENSE](./LICENSE) [LICENSE](./LICENSE)
# ⭐️ スター履歴
[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline)

125
docs/README.zh.md
View File

@ -11,100 +11,131 @@
![](https://github.com/user-attachments/assets/995910f3-177a-4d1e-97ea-04e3b009ba36) ![](https://github.com/user-attachments/assets/995910f3-177a-4d1e-97ea-04e3b009ba36)
Cherry Studio 是一款跨平台桌面客户端，支持多个大语言模型（LLM）服务商，兼容 Windows、Mac 和 Linux 系统，并拥丰富的个性化选项与领先的功能设计。 Cherry Studio 是一款支持多个大语言模型（LLM）服务商的桌面客户端，兼容 Windows、Mac 和 Linux 系统。
👏 欢迎加入 [Telegram 群组](https://t.me/CherryStudioAI) 👏 欢迎加入 [Telegram 群组](https://t.me/CherryStudioAI)
# 🌠 界面 # 🌠 界面
<img width="1582" alt="Xnip2024-09-23_15-01-53" src="https://github.com/user-attachments/assets/554aa31b-87b6-49fe-877d-af313e1608b0"> ![](https://github.com/user-attachments/assets/28585d83-4bf0-4714-b561-8c7bf57cc600)
<img width="1582" alt="Xnip2024-09-23_15-02-27" src="https://github.com/user-attachments/assets/f43fb4c8-194a-4f46-8575-6db2bd136cb9"> ![](https://github.com/user-attachments/assets/8576863a-f632-4776-bc12-657eeced9da3)
<img width="1582" alt="Xnip2024-09-23_16-12-19" src="https://github.com/user-attachments/assets/82ce3cc1-5a0b-49aa-9fe4-0376d34be1f8"> ![](https://github.com/user-attachments/assets/790790d7-b462-48dd-bde1-91c1697a4648)
<img width="1582" alt="Xnip2024-09-23_16-11-44" src="https://github.com/user-attachments/assets/55e420c8-fc0f-40a0-868e-d75bebeb5af3">
<img width="1582" alt="Xnip2024-09-23_16-11-50" src="https://github.com/user-attachments/assets/7413384e-a7c7-4525-96ea-ccd395d7e51a">
<img width="1582" alt="Xnip2024-09-23_16-12-59" src="https://github.com/user-attachments/assets/894b5e97-569f-4471-813c-c48d19455215">
# 🌟 特性 # 🌟 主要特性
<div align="center"> 1. **多样化 LLM 服务支持**：
<a href="https://www.producthunt.com/posts/cherry-studio?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cherry&#0045;studio" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=496640&theme=light" alt="Cherry&#0032;Studio - AI&#0032;Chatbots&#0044;&#0032;AI&#0032;Desktop&#0032;Client | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
</div>
## 😌 轻松上手 - ☁️ 支持主流 LLM 云服务：OpenAI、Gemini、Anthropic、硅基流动等
- 🔗 集成流行 AI Web 服务：Claude、Peplexity、Poe、腾讯元宝、知乎直答等
- 💻 支持 Ollama 本地模型部署
🍏Windows，Mac，Linux跨平台支持 2. **智能助手与对话**：
📦开箱即用，无需 Python 与 Docker - 📚 内置 300+ 预配置 AI 助手
- 🤖 支持自定义创建专属助手
- 💬 多模型同时对话，获得多样化观点
🤝简洁、友好的界面与交互设计 3. **文档与数据处理**：
## 🛠️多样化的 LLM 服务模式支持 - 📄 支持文本、图片、Office、PDF 等多种格式
- ☁️ WebDAV 文件管理与数据备份
- 📊 Mermaid 图表可视化
- 💻 代码高亮显示
☁️ 全面覆盖 LLM 云服务，支持自定义 api key 与模型管理：OpenAI，Gemini，Anthropic，硅基流动... 4. **实用工具集成**：
🔗汇聚流行的 AI Web 服务，并计划通过功能增强提升体验：Claude，Peplexity，Poe，腾讯元宝，知乎直答... - 🔍 全局搜索功能
- 📝 话题管理系统
- 🔤 AI 驱动的翻译功能
- 🎯 拖拽排序
- 🔌 小程序支持
💻支持 Ollama 运行本地模型 5. **优质使用体验**：
- 🖥️ Windows、Mac、Linux 跨平台支持
- 📦 开箱即用，无需配置环境
- 🎨 支持明暗主题与透明窗口
- 📝 完整的 Markdown 渲染
- 🤲 便捷的内容分享功能
## 📲个性化的功能体验 # 🖥️ 开发
📄完整的 Markdown 与 Mermaid 渲染支持 ## IDE 设置
🤖使用与创建智能体提升工作效率 [Cursor](https://www.cursor.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
🔤持续迭代的翻译功能
🤲生成结果支持 Markdown 与图片分享
📎文件与图片上传，RAG 与多模态对话
🎨透明窗口与明暗主题支持
# 🖥️ 开发指南
## 开发环境
[VSCode](https://code.visualstudio.com/) + [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) + [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
## 项目设置 ## 项目设置
### 安装依赖 ### 安装
```bash ```bash
$ yarn $ yarn
``` ```
### 启动开发环境 ### 开发
```bash ```bash
$ yarn dev $ yarn dev
``` ```
### 构建版本 ### 构建
```bash ```bash
# For windows # Windows
$ yarn build:win $ yarn build:win
# For macOS # macOS
$ yarn build:mac $ yarn build:mac
# For Linux # Linux
$ yarn build:linux $ yarn build:linux
``` ```
# ⭐️ Star 记录 # 🤝 贡献
[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline) 我们欢迎对 Cherry Studio 的贡献！您可以通过以下方式贡献：
# 社区 1. **贡献代码**：开发新功能或优化现有代码。
2. **修复错误**：提交您发现的错误修复。
3. **维护问题**：帮助管理 GitHub 问题。
4. **产品设计**：参与设计讨论。
5. **撰写文档**：改进用户手册和指南。
6. **社区参与**：加入讨论并帮助用户。
7. **推广使用**：宣传 Cherry Studio。
[Telegram](https://t.me/CherryStudioAI) ## 入门
# 赞助 1. **Fork 仓库**：Fork 并克隆到您的本地机器。
2. **创建分支**：为您的更改创建分支。
3. **提交更改**：提交并推送您的更改。
4. **打开 Pull Request**：描述您的更改和原因。
有关更详细的指南，请参阅我们的 [贡献指南](./CONTRIBUTING.md)。
感谢您的支持和贡献！
# 🚀 贡献者
<a href="https://github.com/kangfenmao/cherry-studio/graphs/contributors">
<img src="https://contrib.rocks/image?repo=kangfenmao/cherry-studio" />
</a>
<br /><br />
# 🌐 社区
[Telegram](https://t.me/CherryStudioAI) | [Email](mailto:kangfenmao@gmail.com) | [Twitter](https://x.com/kangfenmao)
# 📣 产品猎人
<a href="https://www.producthunt.com/posts/cherry-studio?embed=true&utm_source=badge-featured&utm_medium=badge&utm_souce=badge-cherry&#0045;studio" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=496640&theme=light" alt="Cherry&#0032;Studio - AI&#0032;Chatbots&#0044;&#0032;AI&#0032;Desktop&#0032;Client | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
# ☕ 赞助
[微信赞赏码](sponsor.md) [微信赞赏码](sponsor.md)
# 📃 许可证 # 📃 许可证
[LICENSE](./LICENSE) [LICENSE](./LICENSE)
# ⭐️ Star 记录
[![Star History Chart](https://api.star-history.com/svg?repos=kangfenmao/cherry-studio&type=Timeline)](https://star-history.com/#kangfenmao/cherry-studio&Timeline)