From bdd924801c55c69579d387006037b2d42d2ec1d8 Mon Sep 17 00:00:00 2001 From: zerob13 Date: Sat, 10 Oct 2026 16:32:56 +0800 Subject: [PATCH] docs(readme): reorder sections, fix stale claims - Move Quick Start above Main Features so install steps are not buried - Remove the Ask DeepWiki badge from all three READMEs - Keep sponsor position and order unchanged - Fix stale Skills list, JP Node runtime claim, Bocha naming, and dead links --- README.jp.md | 99 ++++++++++++++++++++++++++------------------------ README.md | 101 +++++++++++++++++++++++++-------------------------- README.zh.md | 101 ++++++++++++++++++++++++++------------------------- 3 files changed, 152 insertions(+), 149 deletions(-) diff --git a/README.jp.md b/README.jp.md index 2c9342926..4d9d14700 100644 --- a/README.jp.md +++ b/README.jp.md @@ -13,7 +13,6 @@ Issues Badge License Badge Downloads - Ask DeepWiki

@@ -65,6 +64,10 @@ - [📑 目次](#-目次) - [🚀 プロジェクト紹介](#-プロジェクト紹介) - [💡 なぜDeepChatを選ぶのか](#-なぜdeepchatを選ぶのか) +- [📦 クイックスタート](#-クイックスタート) + - [ダウンロードとインストール](#ダウンロードとインストール) + - [モデルの設定](#モデルの設定) + - [会話を開始](#会話を開始) - [🔥 主な機能](#-主な機能) - [📼 Tape と Trace](#-tape-と-trace) - [🧠 Skills サポート](#-skills-サポート) @@ -73,10 +76,6 @@ - [🤖 サポートされているモデルプロバイダー](#-サポートされているモデルプロバイダー) - [OpenAI/Gemini/Anthropic API形式の任意のモデルプロバイダーと互換性あり](#openaigeminianthropic-api形式の任意のモデルプロバイダーと互換性あり) - [🔍 ユースケース](#-ユースケース) -- [📦 クイックスタート](#-クイックスタート) - - [ダウンロードとインストール](#ダウンロードとインストール) - - [モデルの設定](#モデルの設定) - - [会話を開始](#会話を開始) - [💻 開発ガイド](#-開発ガイド) - [依存関係のインストール](#依存関係のインストール) - [開発を開始](#開発を開始) @@ -119,6 +118,45 @@ DeepChatのセッションとAgentプロセスはTape.systemsの哲学に基づ - **プライバシー重視**: ローカルデータストレージとネットワークプロキシのサポートにより、情報漏洩のリスクを軽減します - **ビジネスフレンドリー**: Apache License 2.0の下でオープンソース化され、商用・個人利用の両方に適しています +## 📦 クイックスタート + +### ダウンロードとインストール + +以下のいずれかの方法で DeepChat をインストールできます： + +**方法1：GitHub Releases** + +[GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases)ページからお使いのシステム用の最新バージョンをダウンロードしてください： + +- Windows: `.exe`インストールファイル +- macOS: `.dmg`インストールファイル +- Linux: `.AppImage`または`.deb`インストールファイル + +**方法2：公式ウェブサイト** + +[公式ウェブサイト](https://deepchatai.cn/#/download)からダウンロードできます。 + +**方法3：Homebrew（macOS のみ）** + +macOS ユーザーは Homebrew を使用してインストールできます： + +```bash +brew install --cask deepchat +``` + +### モデルの設定 + +1. DeepChatアプリケーションを起動 +2. 設定アイコンをクリック +3. "モデルプロバイダー"タブを選択 +4. APIキーを追加するか、ローカルOllamaを設定 + +### 会話を開始 + +1. "+"ボタンをクリックして新しい会話を作成 +2. 使用したいモデルを選択 +3. AIアシスタントとの対話を開始 + ## 🔥 主な機能 - 🤖 **ローカルファーストAgentデスクトップクライアント** @@ -149,13 +187,13 @@ DeepChatのセッションとAgentプロセスはTape.systemsの哲学に基づ - 画像、Mermaidダイアグラム、その他のマルチモーダルコンテンツのレンダリングをサポート。GPT-4o、Gemini、Grokのテキストから画像生成機能をサポート - 検索結果などの外部情報ソースをコンテンツ内でハイライト表示 - 🔍 **強力な検索強化機能** - - 博查搜索、Brave Searchなどの主要な検索APIを組み込み、モデルが検索のタイミングを賢く判断 + - Bocha Search、Brave Searchなどの主要な検索APIを統合し、モデルが検索のタイミングを賢く判断 - ユーザーのウェブブラウジングをシミュレートすることで、Google、Bing、Baidu、Sogou公式アカウント検索などの主要検索エンジンをサポート - あらゆる検索エンジンの読み取りをサポート。検索アシスタントモデルを設定するだけで、内部ネットワーク、APIなしのエンジン、垂直ドメイン検索エンジンなど、様々な情報ソースをモデルに接続可能 - 🔧 **優れたMCP（Model Context Protocol）サポート** - Resources / Prompts / Tools の三大コア機能をサポート - StreamableHTTP、SSE、StdioなどのTransportに対応 - - 組み込みNode.jsランタイムにより、npx/node系サービスがすぐに利用可能 + - npx/node系サービス向けの公式Node.jsツールチェーンを、必要なときに設定からインストール可能 - コード実行、Web情報取得、ファイル操作などのinMemoryサービスに対応 - ツール呼び出し、パラメータ、戻り値を見やすくデバッグ可能 - DeepLinkによるMCPサービスのワンクリックインストールに対応 @@ -180,7 +218,7 @@ DeepChat Skills は標準の Agent Skills 仕様と互換性のある設計で Skillsはフォルダー、ZIPファイル、URLからインストールできます。Claude Code、Codex、Cursor、Windsurf、GitHub Copilot、Kiro、Antigravity、OpenCode、Goose、Kilo Code などの互換ツールとのインポート/エクスポートにも対応します。 -組み込みSkillsは、生成アート、コードレビュー、DeepChat設定、ドキュメント共同作成、DOCX、フロントエンド設計、git commitメッセージ、インフォグラフィック構文、MCP構築、PDF、PPTX、Skill作成、Web Artifacts、XLSXワークフローをカバーします。 +組み込みSkillsは、アルゴリズムアート、コードレビュー、DeepChat CLI、DeepChat設定、ドキュメント共同作成、DOCX、フロントエンド設計、git commitメッセージ、インフォグラフィック構文、MCP構築、メモリ管理、PDF、PPTX、Skill作成、XLSXワークフローをカバーします。 クイックスタート： @@ -424,6 +462,8 @@ DeepChatはメッセージアプリからリモート操作できるため、デ ### OpenAI/Gemini/Anthropic API形式の任意のモデルプロバイダーと互換性あり +上記の組み込みプロバイダーに加えて、OpenAI、Gemini、Anthropic API形式と互換性のある任意のサービスをカスタムプロバイダーとして追加できます。 + ## 🔍 ユースケース DeepChatは様々なAIアプリケーションシナリオに適しています： @@ -434,45 +474,6 @@ DeepChatは様々なAIアプリケーションシナリオに適しています - **コンテンツ作成**: コピーライティング、クリエイティブなインスピレーション、コンテンツの最適化 - **データ分析**: データの解釈、チャート生成、レポート作成 -## 📦 クイックスタート - -### ダウンロードとインストール - -以下のいずれかの方法で DeepChat をインストールできます： - -**方法1：GitHub Releases** - -[GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases)ページからお使いのシステム用の最新バージョンをダウンロードしてください： - -- Windows: `.exe`インストールファイル -- macOS: `.dmg`インストールファイル -- Linux: `.AppImage`または`.deb`インストールファイル - -**方法2：公式ウェブサイト** - -[公式ウェブサイト](https://deepchatai.cn/#/download)からダウンロードできます。 - -**方法3：Homebrew（macOS のみ）** - -macOS ユーザーは Homebrew を使用してインストールできます： - -```bash -brew install --cask deepchat -``` - -### モデルの設定 - -1. DeepChatアプリケーションを起動 -2. 設定アイコンをクリック -3. "モデルプロバイダー"タブを選択 -4. APIキーを追加するか、ローカルOllamaを設定 - -### 会話を開始 - -1. "+"ボタンをクリックして新しい会話を作成 -2. 使用したいモデルを選択 -3. AIアシスタントとの対話を開始 - ## 💻 開発ガイド [貢献ガイドライン](./CONTRIBUTING.md)をお読みください。 @@ -518,6 +519,8 @@ $ pnpm run build:linux:x64 $ pnpm run build:linux:arm64 ``` +開発環境、プロジェクト構成、アーキテクチャの詳細は[開発者ガイド](./docs/guides/getting-started.md)と[ドキュメント索引](./docs/README.md)を参照してください。 + ## 👥 コミュニティと貢献 DeepChatはアクティブなオープンソースコミュニティプロジェクトであり、様々な形での貢献を歓迎します： @@ -526,7 +529,7 @@ DeepChatはアクティブなオープンソースコミュニティプロジェ - 💡 [機能の提案を提出する](https://github.com/ThinkInAIXYZ/deepchat/issues) - 🔧 [コードの改善を提出する](https://github.com/ThinkInAIXYZ/deepchat/pulls) - 📚 [ドキュメントを改善する](https://github.com/ThinkInAIXYZ/deepchat/wiki) -- 🌍 [翻訳を手伝う](https://github.com/ThinkInAIXYZ/deepchat/tree/main/locales) +- 🌍 [翻訳を手伝う](https://github.com/ThinkInAIXYZ/deepchat/tree/main/src/renderer/src/i18n) プロジェクトへの参加方法について詳しく知るには、[貢献ガイドライン](./CONTRIBUTING.md)をご確認ください。 diff --git a/README.md b/README.md index b914017f6..04dcde419 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ Issues Badge License Badge Downloads - Ask DeepWiki

@@ -64,6 +63,10 @@ - [📑 Table of Contents](#-table-of-contents) - [🚀 Project Introduction](#-project-introduction) - [💡 Why Choose DeepChat](#-why-choose-deepchat) +- [📦 Quick Start](#-quick-start) + - [Download and Install](#download-and-install) + - [Configure Models](#configure-models) + - [Start Conversations](#start-conversations) - [🔥 Main Features](#-main-features) - [📼 Tape & Trace](#-tape--trace) - [🧠 Skills Support](#-skills-support) @@ -72,10 +75,6 @@ - [🤖 Supported Model Providers](#-supported-model-providers) - [Compatible with any model provider in OpenAI/Gemini/Anthropic API format](#compatible-with-any-model-provider-in-openaigeminianthropic-api-format) - [🔍 Use Cases](#-use-cases) -- [📦 Quick Start](#-quick-start) - - [Download and Install](#download-and-install) - - [Configure Models](#configure-models) - - [Start Conversations](#start-conversations) - [💻 Development Guide](#-development-guide) - [Install Dependencies](#install-dependencies) - [Start Development](#start-development) @@ -118,6 +117,45 @@ Compared to other AI tools, DeepChat offers the following unique advantages: - **Privacy-Focused**: Local data storage and network proxy support reduce the risk of information leakage - **Business-Friendly**: Embraces open source under the Apache License 2.0, suitable for both commercial and personal use +## 📦 Quick Start + +### Download and Install + +You can install DeepChat using one of the following methods: + +**Option 1: GitHub Releases** + +Download the latest version for your system from the [GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases) page: + +- Windows: `.exe` installation file +- macOS: `.dmg` installation file +- Linux: `.AppImage` or `.deb` installation file + +**Option 2: Official Website** + +Download from the [official website](https://deepchatai.cn/#/download). + +**Option 3: Homebrew (macOS only)** + +For macOS users, you can install DeepChat using Homebrew: + +```bash +brew install --cask deepchat +``` + +### Configure Models + +1. Launch the DeepChat application +2. Click the settings icon +3. Select the "Model Providers" tab +4. Add your API keys or configure local Ollama + +### Start Conversations + +1. Click the "+" button to create a new conversation +2. Select the model you want to use +3. Start communicating with your AI assistant + ## 🔥 Main Features - 🤖 **Local-First Agent Desktop Client** @@ -148,7 +186,7 @@ Compared to other AI tools, DeepChat offers the following unique advantages: - Supports rendering images, Mermaid diagrams, and other multi-modal content; supports GPT-4o, Gemini, Grok text-to-image capabilities - Supports highlighting external information sources like search results within the content - 🔍 **Robust Search Extension Capabilities** - - Built-in integration with leading search APIs like BoSearch and Brave Search, allowing the model to intelligently decide when to search + - Built-in integration with leading search APIs like Bocha Search and Brave Search, allowing the model to intelligently decide when to search - Supports mainstream search engines like Google, Bing, Baidu, and Sogou Official Accounts search by simulating user web browsing, enabling the LLM to read search engines like a human - Supports reading any search engine; simply configure a search assistant model to connect various search sources, whether internal networks, API-less engines, or vertical domain search engines, as information sources for the model - 🔧 **Strong MCP (Model Context Protocol) Support** @@ -169,8 +207,6 @@ Compared to other AI tools, DeepChat offers the following unique advantages: - Clear code structure, both model providers and MCP services are highly decoupled, can be freely customized with minimal cost - Reasonable architecture, data interaction and UI behavior separation, fully utilizing Electron's capabilities, rejecting simple web wrappers, excellent performance -For more details on how to use these features, see the [documentation index](./docs/README.md). - ## 📼 Tape & Trace DeepChat's session Tape follows the Tape.systems philosophy and keeps agent work recoverable and inspectable. Trace previews expose request sequences, provider/model metadata, Tape view manifests, included or excluded entries, and token budgets, making long-running agent sessions easier to debug and resume. @@ -181,7 +217,7 @@ DeepChat Skills are designed to be compatible with the standard Agent Skills spe You can install Skills from folders, ZIP files, or URLs, and import/export them with Claude Code, Codex, Cursor, Windsurf, GitHub Copilot, Kiro, Antigravity, OpenCode, Goose, Kilo Code, and other compatible tools. -Built-in Skills cover generative art, code review, DeepChat settings, document collaboration, DOCX, frontend design, git commit messages, infographic syntax, MCP building, PDF, PPTX, Skill creation, Web Artifacts, and XLSX workflows. +Built-in Skills cover algorithmic art, code review, DeepChat CLI, DeepChat settings, document collaboration, DOCX, frontend design, git commit messages, infographic syntax, MCP building, memory management, PDF, PPTX, Skill creation, and XLSX workflows. Quick start: @@ -425,6 +461,8 @@ Common commands include `/start`, `/help`, `/pair`, `/new`, `/sessions`, `/use`, ### Compatible with any model provider in OpenAI/Gemini/Anthropic API format +Any service that speaks the OpenAI, Gemini, or Anthropic API format can be added as a custom provider next to the built-in ones. + ## 🔍 Use Cases DeepChat is suitable for various AI application scenarios: @@ -435,47 +473,6 @@ DeepChat is suitable for various AI application scenarios: - **Content Creation**: Copywriting, creative inspiration, content optimization - **Data Analysis**: Data interpretation, chart generation, report writing -## 📦 Quick Start - -### Download and Install - -You can install DeepChat using one of the following methods: - -**Option 1: GitHub Releases** - -Download the latest version for your system from the [GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases) page: - -- Windows: `.exe` installation file -- macOS: `.dmg` installation file -- Linux: `.AppImage` or `.deb` installation file - -**Option 2: Official Website** - -Download from the [official website](https://deepchatai.cn/#/download). - -**Option 3: Homebrew (macOS only)** - -For macOS users, you can install DeepChat using Homebrew: - -```bash -brew install --cask deepchat -``` - -### Configure Models - -1. Launch the DeepChat application -2. Click the settings icon -3. Select the "Model Providers" tab -4. Add your API keys or configure local Ollama - -### Start Conversations - -1. Click the "+" button to create a new conversation -2. Select the model you want to use -3. Start communicating with your AI assistant - -For a comprehensive guide on getting started and using all features, please refer to the [documentation index](./docs/README.md). - ## 💻 Development Guide Please read the [Contribution Guidelines](./CONTRIBUTING.md) @@ -521,7 +518,7 @@ $ pnpm run build:linux:x64 $ pnpm run build:linux:arm64 ``` -For a more detailed guide on development, project structure, and architecture, please see the [Developer Guide](./docs/guides/getting-started.md). +For a more detailed guide on development, project structure, and architecture, please see the [Developer Guide](./docs/guides/getting-started.md) and the maintained [documentation index](./docs/README.md). ## 👥 Community & Contribution @@ -531,7 +528,7 @@ DeepChat is an active open-source community project, and we welcome various form - 💡 [Submit feature suggestions](https://github.com/ThinkInAIXYZ/deepchat/issues) - 🔧 [Submit code improvements](https://github.com/ThinkInAIXYZ/deepchat/pulls) - 📚 [Improve documentation](https://github.com/ThinkInAIXYZ/deepchat/wiki) -- 🌍 [Help with translation](https://github.com/ThinkInAIXYZ/deepchat/tree/main/locales) +- 🌍 [Help with translation](https://github.com/ThinkInAIXYZ/deepchat/tree/main/src/renderer/src/i18n) Check the [Contribution Guidelines](./CONTRIBUTING.md) to learn more about ways to participate in the project. diff --git a/README.zh.md b/README.zh.md index 76cfcc9f5..fa2325d72 100644 --- a/README.zh.md +++ b/README.zh.md @@ -13,7 +13,6 @@ Issues Badge License Badge Downloads - Ask DeepWiki

@@ -62,6 +61,10 @@ - [📑 目录](#-目录) - [🚀 项目简介](#-项目简介) - [💡 为什么选择DeepChat](#-为什么选择deepchat) +- [📦 快速开始](#-快速开始) + - [下载安装](#下载安装) + - [配置模型](#配置模型) + - [开始对话](#开始对话) - [🔥 主要功能](#-主要功能) - [📼 Tape 与 Trace](#-tape-与-trace) - [🧠 Skills 支持](#-skills-支持) @@ -70,10 +73,6 @@ - [🤖 支持的模型提供商](#-支持的模型提供商) - [兼容任何OpenAI/Gemini/Anthropic API格式的模型提供商](#兼容任何openaigeminianthropic-api格式的模型提供商) - [🔍 使用场景](#-使用场景) -- [📦 快速开始](#-快速开始) - - [下载安装](#下载安装) - - [配置模型](#配置模型) - - [开始对话](#开始对话) - [💻 开发指南](#-开发指南) - [安装依赖](#安装依赖) - [开始开发](#开始开发) @@ -116,6 +115,45 @@ DeepChat 的会话与 Agent 过程基于 Tape.systems 的哲学设计：把过 - **注重隐私保护**：本地数据存储，支持网络代理，减少信息泄露风险 - **开源友好**：基于 Apache License 2.0 协议，适合商业和个人使用 +## 📦 快速开始 + +### 下载安装 + +您可以通过以下任一方式安装 DeepChat： + +**方式一：GitHub Releases** + +从[GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases)页面下载适合您系统的最新版本： + +- Windows: `.exe`安装文件 +- macOS: `.dmg`安装文件 +- Linux: `.AppImage`或`.deb`安装文件 + +**方式二：官网下载** + +从[官网下载页面](https://deepchatai.cn/#/download)获取安装包。 + +**方式三：Homebrew（仅 macOS）** + +macOS 用户可以使用 Homebrew 安装： + +```bash +brew install --cask deepchat +``` + +### 配置模型 + +1. 启动DeepChat应用 +2. 点击设置图标 +3. 选择"模型提供商"选项卡 +4. 添加您的API密钥或配置本地Ollama + +### 开始对话 + +1. 点击"+"按钮创建新对话 +2. 选择您想使用的模型 +3. 开始与AI助手交流 + ## 🔥 主要功能 - 🤖 **本地优先 Agent 桌面客户端** @@ -177,7 +215,7 @@ DeepChat Skills 是兼容标准 Agent Skills 规范的设计。一个 Skill 可 你可以从文件夹、ZIP 文件或 URL 安装 Skills，也可以与 Claude Code、Codex、Cursor、Windsurf、GitHub Copilot、Kiro、Antigravity、OpenCode、Goose、Kilo Code 等兼容工具导入/导出。 -内置 Skills 覆盖算法艺术、代码审查、DeepChat 设置、文档协作、DOCX、前端设计、git commit 信息、信息图语法、MCP 构建、PDF、PPTX、Skill 创建、Web Artifacts 和 XLSX 工作流。 +内置 Skills 覆盖算法艺术、代码审查、DeepChat CLI、DeepChat 设置、文档协作、DOCX、前端设计、git commit 信息、信息图语法、MCP 构建、记忆管理、PDF、PPTX、Skill 创建和 XLSX 工作流。 快速上手： @@ -421,6 +459,8 @@ DeepChat 可以通过聊天软件远程控制，让你离开桌面后也能继 ### 兼容任何OpenAI/Gemini/Anthropic API格式的模型提供商 +除了上方的内置提供商，任何兼容 OpenAI、Gemini 或 Anthropic API 格式的服务都可以作为自定义提供商接入。 + ## 🔍 使用场景 DeepChat适用于多种AI应用场景： @@ -431,48 +471,9 @@ DeepChat适用于多种AI应用场景： - **内容创作**：文案撰写、创意激发、内容优化 - **数据分析**：数据解读、图表生成、报告撰写 -## 📦 快速开始 - -### 下载安装 - -您可以通过以下任一方式安装 DeepChat： - -**方式一：GitHub Releases** - -从[GitHub Releases](https://github.com/ThinkInAIXYZ/deepchat/releases)页面下载适合您系统的最新版本： - -- Windows: `.exe`安装文件 -- macOS: `.dmg`安装文件 -- Linux: `.AppImage`或`.deb`安装文件 - -**方式二：官网下载** - -从[官网下载页面](https://deepchatai.cn/#/download)获取安装包。 - -**方式三：Homebrew（仅 macOS）** - -macOS 用户可以使用 Homebrew 安装： - -```bash -brew install --cask deepchat -``` - -### 配置模型 - -1. 启动DeepChat应用 -2. 点击设置图标 -3. 选择"模型提供商"选项卡 -4. 添加您的API密钥或配置本地Ollama - -### 开始对话 - -1. 点击"+"按钮创建新对话 -2. 选择您想使用的模型 -3. 开始与AI助手交流 - ## 💻 开发指南 -请阅读[贡献指南](./CONTRIBUTING.md) +请阅读[贡献指南](./CONTRIBUTING.zh.md) Windows和Linux通过GitHub Action打包。 对于Mac相关的签名和打包，请参考[Mac发布指南](https://github.com/ThinkInAIXYZ/deepchat/wiki/Mac-Release-Guide)。 @@ -515,6 +516,8 @@ $ pnpm run build:linux:x64 $ pnpm run build:linux:arm64 ``` +开发环境、项目结构与架构说明请见[开发者指南](./docs/guides/getting-started.md)和[文档索引](./docs/README.md)。 + ## 👥 社区与贡献 DeepChat是一个活跃的开源社区项目，我们欢迎各种形式的贡献： @@ -523,9 +526,9 @@ DeepChat是一个活跃的开源社区项目，我们欢迎各种形式的贡献 - 💡 [提交功能建议](https://github.com/ThinkInAIXYZ/deepchat/issues) - 🔧 [提交代码改进](https://github.com/ThinkInAIXYZ/deepchat/pulls) - 📚 [完善文档](https://github.com/ThinkInAIXYZ/deepchat/wiki) -- 🌍 [帮助翻译](https://github.com/ThinkInAIXYZ/deepchat/tree/main/locales) +- 🌍 [帮助翻译](https://github.com/ThinkInAIXYZ/deepchat/tree/main/src/renderer/src/i18n) -查看[贡献指南](./CONTRIBUTING.md)了解更多参与项目的方式。 +查看[贡献指南](./CONTRIBUTING.zh.md)了解更多参与项目的方式。 ## ⭐ Star历史 @@ -533,7 +536,7 @@ DeepChat是一个活跃的开源社区项目，我们欢迎各种形式的贡献 ## 👨‍💻 贡献者 -感谢您考虑为deepchat做出贡献！贡献指南可以在[贡献指南](./CONTRIBUTING.md)中找到。 +感谢您考虑为deepchat做出贡献！贡献指南可以在[贡献指南](./CONTRIBUTING.zh.md)中找到。 Contribution Leaderboard