diff --git a/README.md b/README.md index 469f7627..50606a2e 100644 --- a/README.md +++ b/README.md @@ -28,37 +28,38 @@ Cherry Studio is a desktop client that supports for multiple LLM providers, avai 1. **Diverse LLM Provider Support**: - - ☁️ Major LLM Cloud Services: OpenAI, Gemini, Anthropic, and more - - 🔗 AI Web Service Integration: Claude, Peplexity, Poe, and others - - 💻 Local Model Support with Ollama, LM Studio +- ☁️ Major LLM Cloud Services: OpenAI, Gemini, Anthropic, and more +- 🔗 AI Web Service Integration: Claude, Peplexity, Poe, and others +- 💻 Local Model Support with Ollama, LM Studio 2. **AI Assistants & Conversations**: - - 📚 300+ Pre-configured AI Assistants - - 🤖 Custom Assistant Creation - - 💬 Multi-model Simultaneous Conversations +- 📚 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 +- 📄 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 +- 🔍 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 + +- 🖥️ 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 # 📝 TODO @@ -77,36 +78,7 @@ Cherry Studio is a desktop client that supports for multiple LLM providers, avai # 🖥️ Develop -## IDE Setup - -[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 - -### Install - -```bash -yarn -``` - -### Development - -```bash -yarn dev -``` - -### Build - -```bash -# For windows -$ yarn build:win - -# For macOS -$ yarn build:mac - -# For Linux -$ yarn build:linux -``` +Refer to the [development documentation](docs/dev.md) # 🤝 Contributing diff --git a/docs/README.ja.md b/docs/README.ja.md index 221d6ff8..3258f3a1 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -29,37 +29,38 @@ Cherry Studioは、複数のLLMプロバイダーをサポートするデスク 1. **多様な LLM サービス対応**： - - ☁️ 主要な LLM クラウドサービス対応：OpenAI、Gemini、Anthropic など - - 🔗 AI Web サービス統合：Claude、Peplexity、Poe など - - 💻 Ollama、LM Studio によるローカルモデル実行対応 +- ☁️ 主要な LLM クラウドサービス対応：OpenAI、Gemini、Anthropic など +- 🔗 AI Web サービス統合：Claude、Peplexity、Poe など +- 💻 Ollama、LM Studio によるローカルモデル実行対応 2. **AI アシスタントと対話**： - - 📚 300+ の事前設定済み AI アシスタント - - 🤖 カスタム AI アシスタントの作成 - - 💬 複数モデルでの同時対話機能 +- 📚 300+ の事前設定済み AI アシスタント +- 🤖 カスタム AI アシスタントの作成 +- 💬 複数モデルでの同時対話機能 3. **文書とデータ処理**： - - 📄 テキスト、画像、Office、PDF など多様な形式対応 - - ☁️ WebDAV によるファイル管理とバックアップ - - 📊 Mermaid による図表作成 - - 💻 コードハイライト機能 +- 📄 テキスト、画像、Office、PDF など多様な形式対応 +- ☁️ WebDAV によるファイル管理とバックアップ +- 📊 Mermaid による図表作成 +- 💻 コードハイライト機能 4. **実用的なツール統合**： - - 🔍 グローバル検索機能 - - 📝 トピック管理システム - - 🔤 AI による翻訳機能 - - 🎯 ドラッグ＆ドロップによる整理 - - 🔌 ミニプログラム対応 +- 🔍 グローバル検索機能 +- 📝 トピック管理システム +- 🔤 AI による翻訳機能 +- 🎯 ドラッグ＆ドロップによる整理 +- 🔌 ミニプログラム対応 5. **優れたユーザー体験**： - - 🖥️ Windows、Mac、Linux のクロスプラットフォーム対応 - - 📦 環境構築不要ですぐに使用可能 - - 🎨 ライト/ダークテーマと透明ウィンドウ対応 - - 📝 完全な Markdown レンダリング - - 🤲 簡単な共有機能 + +- 🖥️ Windows、Mac、Linux のクロスプラットフォーム対応 +- 📦 環境構築不要ですぐに使用可能 +- 🎨 ライト/ダークテーマと透明ウィンドウ対応 +- 📝 完全な Markdown レンダリング +- 🤲 簡単な共有機能 # 📝 TODO @@ -78,36 +79,7 @@ Cherry Studioは、複数のLLMプロバイダーをサポートするデスク # 🖥️ 開発 -## 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) - -## プロジェクトの設定 - -### インストール - -```bash -$ yarn -``` - -### 開発 - -```bash -$ yarn dev -``` - -### ビルド - -```bash -# Windowsの場合 -$ yarn build:win - -# macOSの場合 -$ yarn build:mac - -# Linuxの場合 -$ yarn build:linux -``` +参考[開発ドキュメント](dev.md) # 🤝 貢献 diff --git a/docs/README.zh.md b/docs/README.zh.md index c0cc0c9e..6639ca3d 100644 --- a/docs/README.zh.md +++ b/docs/README.zh.md @@ -28,37 +28,38 @@ Cherry Studio 是一款支持多个大语言模型（LLM）服务商的桌面客 1. **多样化 LLM 服务支持**： - - ☁️ 支持主流 LLM 云服务：OpenAI、Gemini、Anthropic、硅基流动等 - - 🔗 集成流行 AI Web 服务：Claude、Peplexity、Poe、腾讯元宝、知乎直答等 - - 💻 支持 Ollama、LM Studio 本地模型部署 +- ☁️ 支持主流 LLM 云服务：OpenAI、Gemini、Anthropic、硅基流动等 +- 🔗 集成流行 AI Web 服务：Claude、Peplexity、Poe、腾讯元宝、知乎直答等 +- 💻 支持 Ollama、LM Studio 本地模型部署 2. **智能助手与对话**： - - 📚 内置 300+ 预配置 AI 助手 - - 🤖 支持自定义创建专属助手 - - 💬 多模型同时对话，获得多样化观点 +- 📚 内置 300+ 预配置 AI 助手 +- 🤖 支持自定义创建专属助手 +- 💬 多模型同时对话，获得多样化观点 3. **文档与数据处理**： - - 📄 支持文本、图片、Office、PDF 等多种格式 - - ☁️ WebDAV 文件管理与数据备份 - - 📊 Mermaid 图表可视化 - - 💻 代码高亮显示 +- 📄 支持文本、图片、Office、PDF 等多种格式 +- ☁️ WebDAV 文件管理与数据备份 +- 📊 Mermaid 图表可视化 +- 💻 代码高亮显示 4. **实用工具集成**： - - 🔍 全局搜索功能 - - 📝 话题管理系统 - - 🔤 AI 驱动的翻译功能 - - 🎯 拖拽排序 - - 🔌 小程序支持 +- 🔍 全局搜索功能 +- 📝 话题管理系统 +- 🔤 AI 驱动的翻译功能 +- 🎯 拖拽排序 +- 🔌 小程序支持 5. **优质使用体验**： - - 🖥️ Windows、Mac、Linux 跨平台支持 - - 📦 开箱即用，无需配置环境 - - 🎨 支持明暗主题与透明窗口 - - 📝 完整的 Markdown 渲染 - - 🤲 便捷的内容分享功能 + +- 🖥️ Windows、Mac、Linux 跨平台支持 +- 📦 开箱即用，无需配置环境 +- 🎨 支持明暗主题与透明窗口 +- 📝 完整的 Markdown 渲染 +- 🤲 便捷的内容分享功能 # 📝 待辦事項 @@ -77,36 +78,7 @@ Cherry Studio 是一款支持多个大语言模型（LLM）服务商的桌面客 # 🖥️ 开发 -## 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) - -## 项目设置 - -### 安装 - -```bash -$ yarn -``` - -### 开发 - -```bash -$ yarn dev -``` - -### 构建 - -```bash -# Windows -$ yarn build:win - -# macOS -$ yarn build:mac - -# Linux -$ yarn build:linux -``` +参考[开发文档](dev.md) # 🤝 贡献 diff --git a/docs/dev.md b/docs/dev.md new file mode 100644 index 00000000..ef6733df --- /dev/null +++ b/docs/dev.md @@ -0,0 +1,51 @@ +# 🖥️ Develop + +## IDE Setup + +[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 + +### Install + +```bash +yarn +``` + +### Development + +### Setup Node.js + +Download and install [Node.js v20.x.x](https://nodejs.org/en/download) + +### Setup Yarn + +```bash +corepack enable +corepack prepare yarn@4.6.0 --activate +``` + +### Install Dependencies + +```bash +yarn install +``` + +### Start + +```bash +yarn dev +``` + +### Build + +```bash +# For windows +$ yarn build:win + +# For macOS +$ yarn build:mac + +# For Linux +$ yarn build:linux +```