docs: 完善文档引用和安装说明

主要变更:
1. README.md 和 README_CN.md
   - 添加 COMMAND_SPEC.md 引用链接
   - 区分用户友好参考和技术规范

2. GETTING_STARTED.md
   - 添加 Skill 系统介绍章节
   - 添加 UI 设计工作流介绍
   - 包含 prompt-enhancer 使用示例
   - 包含 explore-auto 和 imitate-auto 示例

3. INSTALL.md 和 INSTALL_CN.md
   - 添加推荐系统工具安装说明(ripgrep, jq)
   - 添加 MCP 工具安装说明(Exa, Code Index, Chrome DevTools)
   - 添加可选 CLI 工具说明(Gemini, Codex, Qwen)
   - 提供各平台安装命令和验证步骤
   - 标注必需和可选工具

改进效果:
- 用户可快速找到技术规范文档
- 新手指南更完整,覆盖高级功能
- 安装文档更详细,包含所有依赖工具

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
catlog22
2025-10-19 09:44:48 +08:00
parent 9151a82d1d
commit ee3a420f60
5 changed files with 147 additions and 0 deletions

View File

@@ -188,6 +188,57 @@ cd Dmsflow
# Use /workflow commands and memory system for development
```
## Prerequisites & Recommended Tools
To unlock the full potential of CCW, installing these additional tools is highly recommended.
### System Tools (Recommended)
These tools enhance file search and data processing capabilities.
- **`ripgrep` (rg)**: A high-speed code search tool.
- **Windows**: `winget install BurntSushi.Ripper.MSVC` or `choco install ripgrep`
- **macOS**: `brew install ripgrep`
- **Linux**: `sudo apt-get install ripgrep` (Debian/Ubuntu) or `sudo dnf install ripgrep` (Fedora)
- **Verify**: `rg --version`
- **`jq`**: A command-line JSON processor.
- **Windows**: `winget install jqlang.jq` or `choco install jq`
- **macOS**: `brew install jq`
- **Linux**: `sudo apt-get install jq` (Debian/Ubuntu) or `sudo dnf install jq` (Fedora)
- **Verify**: `jq --version`
### Model Context Protocol (MCP) Tools (Optional)
MCP tools provide advanced context retrieval from external sources, enhancing the AI's understanding.
- **Prerequisite**: Node.js and npm (or a compatible JavaScript runtime).
- **Installation**:
```bash
npm install -g @modelcontextprotocol/server-exa @modelcontextprotocol/server-code-index @modelcontextprotocol/server-chrome-devtools
```
- **Tools Included**:
- **Exa MCP**: For searching code and the web.
- **Code Index MCP**: For indexing and searching the local codebase.
- **Chrome DevTools MCP**: For interacting with web pages to extract layout and style information.
- **Verify**: After installation, check if the servers can be started (consult MCP documentation for details).
### Optional AI CLI Tools
CCW uses wrapper scripts to interact with underlying AI models. For these wrappers to function, the respective CLI tools must be installed and configured on your system.
- **Gemini CLI**: For analysis, documentation, and exploration.
- **Purpose**: Provides access to Google's Gemini models.
- **Installation**: Follow the official Google AI documentation to install and configure the Gemini CLI. Ensure the `gemini` command is available in your system's PATH.
- **Codex CLI**: For autonomous development and implementation.
- **Purpose**: Provides access to OpenAI's Codex models for code generation and modification.
- **Installation**: Follow the installation instructions for the specific Codex CLI tool used in your environment. Ensure the `codex` command is available in your system's PATH.
- **Qwen Code**: For architecture and code generation.
- **Purpose**: Provides access to Alibaba's Qwen models.
- **Installation**: Follow the official Qwen documentation to install and configure their CLI tool. Ensure the `qwen` command is available in your system's PATH.
## Verification
After installation, verify: