From 74986338f637b06adf522e630dec5b37a0d5a708 Mon Sep 17 00:00:00 2001
From: Ze-Yi LIN <58305964+Zeyi-Lin@users.noreply.github.com>
Date: Tue, 24 Sep 2024 02:50:24 +0800
Subject: [PATCH] docs: update readme (#164)
* Update README.md
* update READMEs
---
README.md | 9 +++++++--
README_EN.md | 4 ++++
README_JP.md | 26 +++++++++++++++++++-------
README_KO.md | 22 +++++++++++++++++-----
4 files changed, 47 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 8db95075..23ef52b6 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,7 @@
- [API服务部署](#️-部署-api-服务)
- [Docker部署](#-docker-部署)
- [联系我们](#-联系我们)
-- [Q&A](#qa)
+- [FAQ](#faq)
- [贡献者](#贡献者)
- [感谢支持](#感谢支持)
- [License](#lincese)
@@ -153,6 +153,8 @@ python scripts/download_model.py --models all
| rmbg-1.4 | [BRIA AI](https://huggingface.co/briaai/RMBG-1.4) 开源的抠图模型 | [下载](https://huggingface.co/briaai/RMBG-1.4/resolve/main/onnx/model.onnx?download=true)(176.2MB)后重命名为`rmbg-1.4.onnx` |
| birefnet-v1-lite | [ZhengPeng7](https://github.com/ZhengPeng7/BiRefNet) 开源的抠图模型,拥有最好的分割精度 | [下载](https://github.com/ZhengPeng7/BiRefNet/releases/download/v1/BiRefNet-general-bb_swin_v1_tiny-epoch_232.onnx)(224MB)后重命名为`birefnet-v1-lite.onnx` |
+> 如果下载网速不顺利:前往[SwanHub](https://swanhub.co/ZeYiLin/HivisionIDPhotos_models/tree/main)下载。
+
## 4. 人脸检测模型配置(可选)
@@ -374,7 +376,7 @@ docker run -d -p 7860:7860 \
-# Q&A
+# FAQ
## 1. 如何修改预设尺寸和颜色?
@@ -394,6 +396,9 @@ docker run -d -p 7860:7860 \
+## 4. 如何修改Gradio Demo的顶部导航栏?
+
+- 修改`demo/assets/title.md`
diff --git a/README_EN.md b/README_EN.md
index ed7a58a0..7eaf64ba 100644
--- a/README_EN.md
+++ b/README_EN.md
@@ -384,6 +384,10 @@ docker run -d -p 7860:7860 \
+## 4. How to Modify the Top Navigation Bar of the Gradio Demo?
+
+- Modify the `demo/assets/title.md` file.
+
# 📧 Contact Us
diff --git a/README_JP.md b/README_JP.md
index a2bfe611..5ec91e1a 100644
--- a/README_JP.md
+++ b/README_JP.md
@@ -358,17 +358,29 @@ docker run -d -p 7860:7860 \
-# 💻 開発のヒント
+# よくある質問 (FAQ)
-## どのようにデフォルトのサイズと色を変更しますか?
+## 1. 基本的なサイズと色をどのように変更しますか?
-- サイズ:`size_list_EN.csv`を修正した後、再度`app.py`を実行すれば、第一列がサイズ名、第二列が高さ、第三列が幅になります。
-- 色:`color_list_EN.csv`を修正した後、再度`app.py`を実行すれば、第一列が色名、第二列がHex値になります。
+- サイズ: [size_list_EN.csv](demo/assets/size_list_EN.csv) ファイルを修正した後、`app.py`を再実行すれば大丈夫です。最初の列はサイズ名、二番目の列は高さ、三番目の列は幅です。
+- 色: [color_list_EN.csv](demo/assets/color_list_EN.csv) ファイルを修正した後、`app.py`を再実行すれば大丈夫です。最初の列は色名、二番目の列はHex値です。
-## ウォーターマークフォントの変更方法
+## 2. ウォーターマークのフォントをどのように変更しますか?
-1. フォントファイルを `hivision/plugin/font` フォルダーに配置します。
-2. `hivision/plugin/watermark.py` の `font_file` パラメータの値をフォントファイルの名前に変更します。
+1. フォントファイルを`hivision/plugin/font`フォルダーに置きます。
+2. `hivision/plugin/watermark.py`ファイル内の`font_file`パラメータの値をフォントファイル名に変更します。
+
+## 3. ソーシャルメディアのテンプレート画像をどのように追加しますか?
+
+1. テンプレート画像を`hivision/plugin/template/assets`フォルダーに置きます。テンプレート画像は4チャンネルの透明PNGです。
+2. `hivision/plugin/template/assets/template_config.json`ファイルに最新のテンプレート情報を追加します。ここで`width`はテンプレート画像の幅(px)、`height`はテンプレート画像の高さ(px)、`anchor_points`はテンプレートの透明領域の4つの隅の座標(px)です。`rotation`は透明領域の垂直方向に対する回転角度で、>0は反時計回り、<0は時計回りです。
+3. `demo/processor.py`の`_generate_image_template`関数内の`TEMPLATE_NAME_LIST`変数に最新のテンプレート名を追加します。
+
+
+
+## 4. Gradio Demoの上部ナビゲーションバーをどのように変更しますか?
+
+- `demo/assets/title.md`ファイルを修正します。
diff --git a/README_KO.md b/README_KO.md
index 5b428138..3f782328 100644
--- a/README_KO.md
+++ b/README_KO.md
@@ -360,17 +360,29 @@ docker run -d -p 7860:7860 \
-# 💻 개발 팁
+# 자주 묻는 질문 (FAQ)
-## 기본 크기와 색상을 어떻게 수정하나요?**
+## 1. 기본 크기와 색상을 어떻게 수정하나요?
- 크기: [size_list_EN.csv](demo/assets/size_list_EN.csv) 파일을 수정한 후 `app.py`를 다시 실행하면 됩니다. 첫 번째 열은 크기 이름, 두 번째 열은 높이, 세 번째 열은 너비입니다.
- 색상: [color_list_EN.csv](demo/assets/color_list_EN.csv) 파일을 수정한 후 `app.py`를 다시 실행하면 됩니다. 첫 번째 열은 색상 이름, 두 번째 열은 Hex 값입니다.
-## 워터마크 폰트 변경 방법
+## 2. 워터마크 글꼴을 어떻게 수정하나요?
-1. 폰트 파일을 `hivision/plugin/font` 폴더에 배치합니다.
-2. `hivision/plugin/watermark.py`의 `font_file` 매개변수 값을 폰트 파일 이름으로 변경합니다.
+1. 글꼴 파일을 `hivision/plugin/font` 폴더에 넣습니다.
+2. `hivision/plugin/watermark.py` 파일에서 `font_file` 매개변수 값을 글꼴 파일 이름으로 수정합니다.
+
+## 3. 소셜 미디어 템플릿 사진을 어떻게 추가하나요?
+
+1. 템플릿 이미지를 `hivision/plugin/template/assets` 폴더에 넣습니다. 템플릿 이미지는 4채널 투명 PNG입니다.
+2. `hivision/plugin/template/assets/template_config.json` 파일에 최신 템플릿 정보를 추가합니다. 여기서 `width`는 템플릿 이미지의 너비(px), `height`는 템플릿 이미지의 높이(px), `anchor_points`는 템플릿의 투명 영역 네 모서리의 좌표(px)입니다. `rotation`은 투명 영역의 수직 방향에 대한 회전 각도로, >0은 반시계 방향, <0은 시계 방향입니다.
+3. `demo/processor.py`의 `_generate_image_template` 함수 내의 `TEMPLATE_NAME_LIST` 변수에 최신 템플릿 이름을 추가합니다.
+
+
+
+## 4. Gradio Demo의 상단 내비게이션 바를 어떻게 수정하나요?
+
+- `demo/assets/title.md` 파일을 수정합니다.