From 05885a5a5461340c63744f440b595f46a398e504 Mon Sep 17 00:00:00 2001
From: luopingyi <luopingyi@4paradigm.com>
Date: Wed, 27 Aug 2025 10:32:10 +0800
Subject: [PATCH] update README.md

---
 bi_v100-f5-tts/README.md | 46 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/bi_v100-f5-tts/README.md b/bi_v100-f5-tts/README.md
index 4896c69..59906b2 100644
--- a/bi_v100-f5-tts/README.md
+++ b/bi_v100-f5-tts/README.md
@@ -1,3 +1,47 @@
 # tiangai100-f5-tts
 
-【语音合成】
\ No newline at end of file
+【语音合成】
+
+本项目基于 **F5-TTS** 模型封装，提供简洁的 Docker 部署方式，支持 **SSML 输入**，输出 **PCM 原始音频**，可用于中文 / 英文 / 中英混合语音合成。
+
+---
+
+## Quickstart
+
+### 1. 安装镜像
+```bash
+docker build -t tts:f5 . -f Dockerfile_f5
+```
+
+### 2. 启动服务
+```bash
+docker run -it --rm \
+  -v /models/F5-TTS_Emilia-ZH-EN:/mnt/models \
+  -v /dev:/dev \
+  --device=/dev/iluvatar0:/dev/iluvatar0 \
+  -p 8080:80 \
+  -e MODEL_DIR=/mnt/models \
+  -e MODEL_NAME=model_1250000.safetensors \
+  tts:f5
+```
+
+参数说明：
+- `MODEL_DIR`：模型所在目录（挂载到容器内 `/mnt/models`）
+- `MODEL_NAME`：加载的模型文件名（通常为 `.safetensors`）
+- `-p 8080:80`：将容器内服务端口映射到宿主机 `8080`
+- `--device=/dev/iluvatar0:/dev/iluvatar0`：指定推理设备（如 GPU/加速卡）
+
+### 3. 测试服务
+```bash
+curl --request POST "http://localhost:8080/tts" \
+  --header 'Content-Type: application/ssml+xml' \
+  --header 'User-Agent: curl' \
+  --data-raw '<speak version="1.0" xml:lang="zh">
+    <voice xml:lang="zh" xml:gender="Female" name="zh">
+      今天天气很好，不知道明天天气怎么样。
+    </voice>
+  </speak>' \
+  --output sound.pcm
+```
+
+---