chore: update files

Author: SWHL

README.md

@@ -12,39 +12,33 @@
 <a href="https://pepy.tech/project/rapidtts"><img src="https://static.pepy.tech/personalized-badge/rapidtts?style=flat-square&period=total&units=abbreviation&left_color=grey&right_color=blue&left_text=Downloads"></a>
 <a href="https://semver.org/"><img alt="SemVer" src="https://img.shields.io/badge/semver-2.0-3D9970?style=flat-square"></a>
 <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000?style=flat-square"></a>
-
 </div>
 
 ## 简介
 
-RapidTTS 是一个轻量级文本转语音工具，面向本地快速推理。当前默认后端是 Kokoro ONNX。
+RapidTTS 是一个轻量级文本转语音工具，面向本地快速推理。当前默认后端是 `kokoro_onnx`，同时支持 `melo_onnx`。
 
 ## 特性
 
 - 支持 Kokoro ONNX 和 MeloTTS ONNX 推理
 - 支持中文、英文和中英混合文本
-- 支持查询每个模型的语言和音色能力
-- 默认模型自动下载，并使用 SHA256 校验
-- 提供命令行工具：下载模型、检查安装、文本合成
-- 提供 Python API，便于集成到应用中
+- 支持查询模型语言、默认参数和音色能力
+- 模型文件可自动下载，并使用 SHA256 校验
+- 同时提供 Python API 和命令行工具
 
 ## 安装
 
+默认推荐安装 Kokoro ONNX 后端：
+
 ```bash
 pip install "rapidtts[kokoro]"
 ```
 
-如果只安装核心包，可以使用 `pip install rapidtts`；运行具体后端前需要安装对应 extra。
+其他安装方式见 [安装说明](docs/installation.md)。
 
 ## 快速使用
 
-命令行合成：
-
-```bash
-rapidtts text "你好，RapidTTS" outputs/1.wav
-```
-
-Python 调用：
+### Python API
 
 ```python
 from rapidtts import RapidTTS, SynthesisRequest
@@ -54,27 +48,50 @@ resp = tts.synthesize(SynthesisRequest(text="你好，RapidTTS"))
 resp.save("outputs/1.wav")
 ```
 
-查看模型支持的语言和音色：
+指定模型和音色：
+
+```python
+from rapidtts import RapidTTS, SynthesisRequest, TTSModel
+
+tts = RapidTTS(model=TTSModel.KOKORO_ONNX)
+resp = tts.synthesize(
+    SynthesisRequest(
+        text="你好，RapidTTS",
+        voice="zm_009",
+    )
+)
+resp.save("outputs/zm_009.wav")
+```
+
+更多示例见 [Python API](docs/python_api.md)。
+
+### 命令行
+
+```bash
+rapidtts text "你好，RapidTTS" outputs/1.wav
+```
+
+指定模型：
 
 ```bash
-rapidtts info kokoro_onnx
-rapidtts voices kokoro_onnx
+rapidtts text "你好，RapidTTS" outputs/kokoro.wav --model kokoro_onnx
 ```
 
-## 支持的模型和语言
+指定模型和音色：
+
+```bash
+rapidtts text "你好，RapidTTS" outputs/zm_009.wav --model kokoro_onnx --voice zm_009
+```
 
-|模型名称|支持语言|备注|
-|:---|:---|:---|
-|`kokoro_onnx`|中英混合|默认后端，支持多音色|
-|`melo_onnx`|中英混合|可选后端，安装 `rapidtts[melo]`|
+更多命令见 [命令行用法](docs/cli.md)。
 
 ## 文档
 
-- [安装说明](docs/installation.md)
-- [命令行用法](docs/cli.md)
-- [Python API](docs/python_api.md)
-- [模型文件](docs/models.md)
-- [开发说明](docs/development.md)
+- [安装说明](docs/installation.md)：安装 extra、检查依赖和模型文件
+- [Python API](docs/python_api.md)：在代码中指定模型、音色、语言、语速和模型目录
+- [命令行用法](docs/cli.md)：下载模型、检查安装、查询能力、合成音频
+- [模型信息](docs/models.md)：支持的模型、语言、音色规则和模型文件
+- [开发说明](docs/development.md)：测试、文本归一化和项目结构
 
 ## 致谢
 

docs/cli.md

@@ -1,33 +1,70 @@
 # 命令行用法
 
-RapidTTS 安装后会提供 `rapidtts` 命令。
+RapidTTS 安装后会提供 `rapidtts` 命令。CLI 适合下载模型、检查环境、查看模型能力，以及从文本生成音频文件。
 
 ## 命令速查
 
 ```bash
-rapidtts download [kokoro_onnx] [--save-dir DIR] [--no-progress] [--quiet]
-rapidtts check [kokoro_onnx] [--model-dir DIR] [--init-backend] [--quiet]
-rapidtts info [kokoro_onnx] [--model-dir DIR] [--quiet]
-rapidtts voices [kokoro_onnx] [--model-dir DIR] [--quiet]
-rapidtts text TEXT OUTPUT [--model kokoro_onnx] [--model-dir DIR] [--language ZH|EN|ZH_MIX_EN] [--speed SPEED] [--sample-rate SAMPLE_RATE] [--quiet]
+rapidtts download [MODEL] [--save-dir DIR] [--no-progress] [--quiet]
+rapidtts check [MODEL] [--model-dir DIR] [--init-backend] [--quiet]
+rapidtts info [MODEL] [--model-dir DIR] [--quiet]
+rapidtts voices [MODEL] [--model-dir DIR] [--quiet]
+rapidtts text TEXT OUTPUT [--model MODEL] [--model-dir DIR] [--language ZH|EN|ZH_MIX_EN] [--voice VOICE] [--speed SPEED] [--sample-rate SAMPLE_RATE] [--quiet]
 ```
 
-## 检查安装
+`MODEL` 可选：
+
+- `kokoro_onnx`：默认后端
+- `melo_onnx`：MeloTTS ONNX 后端
+
+## 生成音频
+
+最小示例：
 
 ```bash
-rapidtts check
+rapidtts text "你好，RapidTTS" outputs/1.wav
 ```
 
-检查自定义模型目录：
+指定模型：
 
 ```bash
-rapidtts check kokoro_onnx --model-dir /path/to/kokoro_onnx
+rapidtts text "你好，RapidTTS" outputs/kokoro.wav --model kokoro_onnx
+rapidtts text "你好，RapidTTS" outputs/melo.wav --model melo_onnx
 ```
 
-同时初始化后端：
+指定语言：
 
 ```bash
-rapidtts check --init-backend
+rapidtts text "hello world" outputs/en.wav --language EN
+rapidtts text "你好，RapidTTS" outputs/zh.wav --language ZH
+rapidtts text "我在学习machine learning" outputs/mix.wav --language ZH_MIX_EN
+```
+
+指定音色：
+
+```bash
+rapidtts voices kokoro_onnx
+rapidtts text "你好，RapidTTS" outputs/zm_009.wav --model kokoro_onnx --voice zm_009
+```
+
+`--voice` 对应 Python API 中的 `SynthesisRequest.voice`。
+
+MeloTTS ONNX 当前只暴露 `zf_001`：
+
+```bash
+rapidtts text "你好，RapidTTS" outputs/melo_zf_001.wav --model melo_onnx --voice zf_001
+```
+
+指定语速和采样率：
+
+```bash
+rapidtts text "你好，RapidTTS" outputs/fast.wav --speed 1.2 --sample-rate 16000
+```
+
+使用自定义模型目录：
+
+```bash
+rapidtts text "你好，RapidTTS" outputs/1.wav --model kokoro_onnx --model-dir /path/to/kokoro_onnx
 ```
 
 ## 查看模型能力
@@ -44,16 +81,9 @@ rapidtts info kokoro_onnx
 rapidtts voices kokoro_onnx
 ```
 
-Kokoro ONNX 是默认后端，建议安装：
+查看 MeloTTS ONNX：
 
 ```bash
-pip install "rapidtts[kokoro]"
-```
-
-MeloTTS 后端需要额外依赖：
-
-```bash
-pip install "rapidtts[melo]"
 rapidtts info melo_onnx
 rapidtts voices melo_onnx
 ```
@@ -78,37 +108,35 @@ rapidtts download kokoro_onnx --save-dir /path/to/kokoro_onnx
 rapidtts download kokoro_onnx --no-progress
 ```
 
-关闭日志：
-
-```bash
-rapidtts download kokoro_onnx --quiet
-```
+## 检查安装
 
-## 文本合成
+检查默认模型和依赖：
 
 ```bash
-rapidtts text "你好，RapidTTS" outputs/1.wav
+rapidtts check
 ```
 
-指定语言：
+检查指定模型：
 
 ```bash
-rapidtts text "hello world" outputs/en.wav --language EN
+rapidtts check melo_onnx
 ```
 
-指定语速和采样率：
+检查自定义模型目录：
 
 ```bash
-rapidtts text "你好，RapidTTS" outputs/1.wav --speed 1.2 --sample-rate 16000
+rapidtts check kokoro_onnx --model-dir /path/to/kokoro_onnx
 ```
 
-使用自定义模型目录：
+同时初始化后端：
 
 ```bash
-rapidtts text "你好，RapidTTS" outputs/1.wav --model-dir /path/to/melotts_zh_mix_en_onnx
+rapidtts check kokoro_onnx --init-backend
 ```
 
-关闭 RapidTTS 日志：
+## 关闭日志
+
+所有子命令都支持 `--quiet`：
 
 ```bash
 rapidtts text "你好，RapidTTS" outputs/1.wav --quiet

docs/installation.md

@@ -1,20 +1,25 @@
 # 安装说明
 
+默认推荐安装 Kokoro ONNX 后端：
+
 ```bash
 pip install "rapidtts[kokoro]"
 ```
 
-`pip install rapidtts` 只安装核心依赖。使用具体后端时建议安装对应 extra：
+## 安装选项
 
 ```bash
-pip install "rapidtts[kokoro]"  # 默认 Kokoro ONNX 后端
-pip install "rapidtts[melo]"    # MeloTTS 后端
-pip install "rapidtts[all]"     # 所有后端
+pip install rapidtts            # 只安装核心依赖
+pip install "rapidtts[kokoro]"  # 安装默认 Kokoro ONNX 后端
+pip install "rapidtts[melo]"    # 安装 MeloTTS ONNX 后端
+pip install "rapidtts[all]"     # 安装全部后端依赖
 ```
 
+只安装 `rapidtts` 时不会安装具体后端的额外依赖。运行某个后端前，请安装对应 extra。
+
 ## 检查安装
 
-安装完成后可以运行：
+安装完成后运行：
 
 ```bash
 rapidtts check
@@ -23,23 +28,39 @@ rapidtts check
 该命令会检查：
 
 - RapidTTS 包是否可以正常导入
-- 关键依赖是否存在
+- 当前模型所需依赖是否存在
 - `config.yaml` 和 `models.yaml` 是否可解析
-- 默认模型文件是否存在，SHA256 是否正确
+- 模型文件是否存在，SHA256 是否正确
 
 如果还希望验证后端能否初始化：
 
 ```bash
 rapidtts check --init-backend
 ```
 
-如果模型文件缺失，先执行：
+## 下载模型
+
+如果模型文件缺失，可以手动下载：
 
 ```bash
 rapidtts download kokoro_onnx
 ```
 
-如果需要使用 MeloTTS 后端，额外安装：
+下载到自定义目录：
+
+```bash
+rapidtts download kokoro_onnx --save-dir /path/to/kokoro_onnx
+```
+
+检查自定义目录：
+
+```bash
+rapidtts check kokoro_onnx --model-dir /path/to/kokoro_onnx
+```
+
+## MeloTTS ONNX
+
+使用 MeloTTS ONNX 时安装对应 extra：
 
 ```bash
 pip install "rapidtts[melo]"