diff --git a/INSTALL.md b/INSTALL.md index 82545ed1..dde84140 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -100,7 +100,7 @@ Install to user home directory (`~/.claude`): ├── commands/ ├── output-styles/ ├── settings.local.json -└── Claude.md +└── CLAUDE.md ``` **Note**: Starting from v1.2.0, only global installation is supported. Local directory and custom path installations have been removed to simplify the installation process and ensure consistent behavior across all platforms. diff --git a/INSTALL_CN.md b/INSTALL_CN.md index cc976d44..bbf2b65e 100644 --- a/INSTALL_CN.md +++ b/INSTALL_CN.md @@ -97,7 +97,7 @@ iex (iwr -useb https://raw.githubusercontent.com/catlog22/Dmsflow/main/install-r ├── commands/ ├── output-styles/ ├── settings.local.json -└── Claude.md +└── CLAUDE.md ``` **注意**:从 v1.2.0 开始,仅支持全局安装。移除了本地目录和自定义路径安装,以简化安装流程并确保所有平台的一致行为。 diff --git a/README.md b/README.md index 3d6239b1..6b4d857b 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,10 @@ CCW intelligently adapts its file structure and workflow processes based on unif ## 🚀 Quick Start +### Prerequisites +Install and configure [Gemini CLI](https://github.com/google-gemini/gemini-cli) for optimal workflow integration. + +### Installation **One-liner installation:** ```powershell Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content @@ -97,6 +101,17 @@ Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/cat /workflow:session list ``` +### Essential Configuration +For Gemini CLI integration, configure your `settings.json` file: + +```json +{ + "contextFileName": "CLAUDE.md" +} +``` + +> **⚠️ Important**: Set `"contextFileName": "CLAUDE.md"` in your Gemini CLI `settings.json` to ensure proper integration with CCW's intelligent documentation system. This can be set in your user settings (`~/.gemini/settings.json`) or project settings (`.gemini/settings.json`). + ## 📚 Complete Command Reference ### Core Commands diff --git a/README_CN.md b/README_CN.md index fbe1f507..e4e4693e 100644 --- a/README_CN.md +++ b/README_CN.md @@ -87,6 +87,10 @@ CCW 根据统一的任务数量阈值智能调整其文件结构和工作流程 ## 🚀 快速开始 +### 前置条件 +安装并配置 [Gemini CLI](https://github.com/google-gemini/gemini-cli) 以实现最佳工作流集成。 + +### 安装 **一键安装:** ```powershell Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content @@ -97,6 +101,17 @@ Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/cat /workflow:session list ``` +### 重要配置 +为了实现 Gemini CLI 集成,请配置您的 `settings.json` 文件: + +```json +{ + "contextFileName": "CLAUDE.md" +} +``` + +> **⚠️ 重要提示**:在您的 Gemini CLI `settings.json` 中设置 `"contextFileName": "CLAUDE.md"` 以确保与 CCW 的智能文档系统正确集成。这可以在用户设置 (`~/.gemini/settings.json`) 或项目设置 (`.gemini/settings.json`) 中设置。 + ## 📚 完整命令参考 ### 核心命令