Skip to content

FunASR-powered video transcription, subtitle generation, and LLM-assisted clipping tool with a local Gradio UI.

docs: make CLI quickstart runnable (fetch the example video) (#162)

zhifu gao27c9d5103365
diff --git a/README.md b/README.md
index 5f3c494..34bd5d4 100644
--- a/README.md
+++ b/README.md
@@ -137,6 +137,10 @@ Follow the guide below to explore LLM based clipping:
FunClip supports you to recognize and clip with commands:
```shell
+# download the example video used in the commands below
+mkdir -p examples
+wget "https://huggingface.co/spaces/R1ckShi/FunClip/resolve/main/examples/2022%E4%BA%91%E6%A0%96%E5%A4%A7%E4%BC%9A_%E7%89%87%E6%AE%B5.mp4" -O "examples/2022云栖大会_片段.mp4"
+
# step1: Recognize
python funclip/videoclipper.py --stage 1 \
--file examples/2022云栖大会_片段.mp4 \
diff --git a/README_zh.md b/README_zh.md
index d9d5633..94a4112 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -127,6 +127,10 @@ python funclip/launch.py
### B.通过命令行调用使用FunClip的相关功能
```shell
+# 下载下面命令用到的示例视频
+mkdir -p examples
+wget "https://huggingface.co/spaces/R1ckShi/FunClip/resolve/main/examples/2022%E4%BA%91%E6%A0%96%E5%A4%A7%E4%BC%9A_%E7%89%87%E6%AE%B5.mp4" -O "examples/2022云栖大会_片段.mp4"
+
# 步骤一:识别
python funclip/videoclipper.py --stage 1 \
--file examples/2022云栖大会_片段.mp4 \