From 9129d7c27a62db4eef8061152d01395023192bfd Mon Sep 17 00:00:00 2001
From: xxxsen <naivesen@gmail.com>
Date: Thu, 4 Jul 2024 22:04:19 +0800
Subject: [PATCH] doc: add readme

---
 README.md                                     | 46 +++++++++++++++++++
 config/config.go                              |  1 -
 main.go                                       |  2 +-
 .../download_models.sh                        |  0
 4 files changed, 47 insertions(+), 2 deletions(-)
 create mode 100644 README.md
 rename download_models.sh => scripts/download_models.sh (100%)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..23f908f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+av-capture
+===
+
+由于原先的MovieDataCapture作者把工具闭源了, 只能自己写一个了。
+
+## 使用方式
+
+使用docker进行部署, 对应的`docker-compose.yml`参考下面文件
+
+```yaml
+version: "3.1"
+services:
+  av-capture:
+    image: xxxsen/av-capture:latest
+    container_name: av-capture
+    volumes:
+      - /data/scandir:/scandir
+      - /data/savedir:/savedir
+      - /data/datadir:/datadir
+      - /data/config:/config
+    command: --config=/config/config.json
+```
+
+需要挂载扫描目录(/scandir), 存储目录(/savedir), 数据目录(/datadir)和配置目录(/config), 这几个目录在自己的配置文件中指定。
+
+配置完成后, 使用`docker compose up` 进行刮削, 刮削完成的电影会被存储到`/data/savedir`下。
+
+**NOTE: 程序依赖go-face进行人脸识别, 以用于识别图片中的人脸并进行截图, 这个库需要有对应的模型文件, 可以通过项目目录下的`scripts/download_models.sh`进行下载, 程序会将模型下载到`models`目录, 之后将该目录移动到数据目录(`/datadir`)下即可**
+
+## 基础配置
+
+```json
+{
+    "scan_dir": "/dir/to/scan",
+    "save_dir": "/dir/to/save/scraped/data",
+    "data_dir": "/dir/to/save/models/and/cache",
+    "naming": "naming rule, specify naming rule you want, example: {YEAR}/{NUMBER}"
+}
+```
+
+|配置项|说明|
+|---|---|
+|scan_dir|扫描目录, 程序会扫描该目录并对其中的影片进行刮削|
+|save_dir|保存目录, 刮削成功的电影会被移动到该目录, 并按`naming`指定的命名规则进行命名|
+|data_dir|数据目录, 存储中间文件或者模型文件的|
+|naming|命名规则, 可用的命名标签如下:{DATE}, {YEAR}, {MONTH}, {NUMBER}, {ACTOR}|
\ No newline at end of file
diff --git a/config/config.go b/config/config.go
index 25c9edd..36a568d 100644
--- a/config/config.go
+++ b/config/config.go
@@ -11,7 +11,6 @@ type Config struct {
 	ScanDir       string                 `json:"scan_dir"`
 	SaveDir       string                 `json:"save_dir"`
 	DataDir       string                 `json:"data_dir"`
-	ModelDir      string                 `json:"model_dir"`
 	Naming        string                 `json:"naming"`
 	PluginConfig  map[string]interface{} `json:"plugin_config"`
 	HandlerConfig map[string]interface{} `json:"handler_config"`
diff --git a/main.go b/main.go
index e486ddc..3f8436b 100644
--- a/main.go
+++ b/main.go
@@ -51,7 +51,7 @@ func main() {
 	if err := translater.Init(); err != nil {
 		logkit.Fatal("init translater failed", zap.Error(err))
 	}
-	if err := image.Init(c.ModelDir); err != nil {
+	if err := image.Init(filepath.Join(c.DataDir, "models")); err != nil {
 		logkit.Fatal("init image recognizer failed", zap.Error(err))
 	}
 	ss, err := buildSearcher(c.Plugins, c.PluginConfig)
diff --git a/download_models.sh b/scripts/download_models.sh
similarity index 100%
rename from download_models.sh
rename to scripts/download_models.sh