From d266b5c93bbb161f14b30800e8c58789e43ca383 Mon Sep 17 00:00:00 2001
From: b5f0d6c3 <a@b.c>
Date: Tue, 19 Oct 2021 20:27:13 +0800
Subject: update README.md

---
 README.md | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 52 insertions(+), 5 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c23aa1b..3f284f2 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,54 @@
 # Mkv Auto Subset
-![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/KurenaiRyu/MkvAutoSubset?include_prereleases)  
-  
-自动字体子集化工具  
 
----
-本人只是代发github
+![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/KurenaiRyu/MkvAutoSubset?include_prereleases)
+
+自动字体子集化工具
+
+## mkvtool 功能及使用示例
+
+- 从单个(或文件夹的)mkv文件里抽取字幕和字体*并创建子集化后的版本(可选)*
+  ```shell
+  mkvtool -d -f file.mkv #单个文件
+  mkvtool -d -s bangumi #文件夹
+  #可选"-n"参数:当"-n"存在时,只抽取内容,不进行子集化操作.
+  #可选"-data"参数,指定输出目录,默认输出到"${workdir}/data".
+  ```
+- 检测单个(或文件夹的)mkv文件字幕和字体,判断是否需要子集化.
+  ```shell
+  mkvtool -q -f file.mkv #单个文件,会直接输出是否需要子集化
+  mkvtool -q -s bangumi #文件夹,会将需要子集化的文件列表输出至"${workdir}/list.txt".
+  ```
+- 将子集化后的字幕与字体替代原有的内容
+  ```shell
+  mkvtool -m -s bangumi -data data -dist dist
+  #-data参数默认值为"${workdir}/data"
+  #-dist参数默认值为"${workdir}/dist"
+  #假设bangumi文件夹里的目录结构如下所示:
+  #bangumi
+  # |-- S01
+  # ||-- abc S01E01.mkv
+  # ||-- abc SxxExx.mkv
+  # |-- SP.mkv
+  # |-- xx.mkv
+  #那么对应的data文件夹的目录结构应该是如下的所示:
+  #data
+  # |-- S01
+  # ||-- abc S01E01
+  # |||-- ...
+  # |||-- subsetted
+  # |||-- xxx.sub
+  # ||-- abc SxxExx
+  # |||-- ...
+  # |||-- subsetted
+  # |||-- xxx.sub
+  # |-- SP
+  # |||-- ...
+  # |||-- subsetted
+  # |||-- xxx.sub
+  # |-- xx
+  # |||-- ...
+  # |||-- subsetted
+  # |||-- xxx.sub
+  
+  #*奇淫巧技:指定一个没有任何内容的data目录,将输出一个"干净的"mkv文件.
+   ```
\ No newline at end of file
-- 
cgit v1.2.1