From c38330f5c73008462fc7fb09def217d760fab21c Mon Sep 17 00:00:00 2001
From: chflame <chflame@163.com>
Date: Mon, 18 Mar 2024 23:32:16 +0800
Subject: [PATCH] update readme

---
 README.MD    | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 README_CN.MD | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 91 insertions(+)

diff --git a/README.MD b/README.MD
index f5c6259..0f40f25 100644
--- a/README.MD
+++ b/README.MD
@@ -34,6 +34,52 @@ git clone https://github.com/chflame163/ComfyUI_LayerStyle.git
 
 * Restart ComfyUI.
 
+## Common Issues
+If the node cannot load properly or there are errors during use, please check the error message in the ComfyUI terminal window. The following are common errors and their solutions.
+
+### ImportError:cannot import name 'guidedFilter' from 'cv2.ximgproc'
+This error is caused by incorrect version of the ```opencv-contrib-python``` package，or this package is overwriteen by other opencv packages. 
+
+Solution：
+
+* Close ComfyUI and open the terminal window in the plugin directory and execute the following command:
+```
+ ../../../python_embeded/python.exe -s -m pip uninstall -y opencv-python opencv-python-headless opencv-contrib-python-headless opencv-contrib-python
+```
+* To avoid other plugins install opencv packages, you can install here first, also can skip this step:
+````
+../../../python_embeded/python.exe -s -m pip install opencv-python opencv-python-headless opencv-contrib-python-headless
+````
+* Then install ```opencv-contrib-python```, ensuring that it is the LAST ONE to be installed:
+````
+../../../python_embeded/python.exe -s -m pip install opencv-contrib-python
+````
+* Restart ComfyUI.
+
+### NameError: name 'guidedFilter' is not defined
+The solution is the same as above.
+
+###  cannot import name 'VitMatteImageProcessor' from 'transformers' 
+This error is caused by the low version of ```transformers``` package. Please upgrade it to the latest version. 
+
+Solution：  
+
+* Close ComfyUI and open the terminal window in the plugin directory and execute the following command:
+```
+ ../../../python_embeded/python.exe -s -m pip install transformers==4.38.2
+```
+* Restart ComfyUI.
+
+### ValueError: Trimap did not contain foreground values (xxxx...)
+This error is caused by the mask area being too large or too small when using the ```PyMatting``` method to handle the mask edges.    
+
+Solution：
+* Please adjust the parameters to change the effective area of the mask. Or use other methods to handle the edges.
+
+### requests.exceptions.ProxyError: HTTPSConnectionPool(xxxx...)
+When this error has occurred, please check the network environment.
+
+
 ## Update
 <font size="4">**If the dependency package error after updating, please reinstall the relevant dependency packages. for details, please refer to [here](https://github.com/chflame163/ComfyUI_LayerStyle/issues/5). </font><br />    
 
diff --git a/README_CN.MD b/README_CN.MD
index 682a967..baa52c2 100644
--- a/README_CN.MD
+++ b/README_CN.MD
@@ -27,6 +27,51 @@ git clone https://github.com/chflame163/ComfyUI_LayerStyle.git
 
   重新打开ComfyUI。
 
+## 常见问题
+如果节点不能正常加载，或者使用中出现错误，请在ComfyUI终端窗口查看报错信息。以下是常见的错误及解决方法。
+### ImportError:cannot import name 'guidedFilter' from 'cv2.ximgproc'
+这个错误是```opencv-contrib-python```没有正确安装，或者安装后又安装了其他opencv包导致。    
+
+解决方法：
+
+* 关闭ComfyUI，打开插件目录下的终端窗口，执行以下命令：
+```
+ ../../../python_embeded/python.exe -s -m pip uninstall -y opencv-python opencv-python-headless opencv-contrib-python-headless opencv-contrib-python
+```
+* 为了避免其他插件安装opencv包，可以先在这里安装，也可以跳过这一步:
+````
+../../../python_embeded/python.exe -s -m pip install opencv-python opencv-python-headless opencv-contrib-python-headless
+````
+* 然后安装 ```opencv-contrib-python```, 确保它是最后一个要安装的:
+````
+../../../python_embeded/python.exe -s -m pip install opencv-contrib-python
+````
+* 重新启动 ComfyUI.
+
+### NameError: name 'guidedFilter' is not defined
+解决方法同上。
+
+###  cannot import name 'VitMatteImageProcessor' from 'transformers' 
+这个错误是由于```transformers``` 版本过低造成的。请升级这个依赖包到最新版本。    
+
+解决方法：  
+
+* 关闭ComfyUI，打开插件目录下的终端窗口，执行以下命令：
+```
+ ../../../python_embeded/python.exe -s -m pip install transformers==4.38.2
+```
+* 重新启动 ComfyUI.
+
+### ValueError: Trimap did not contain foreground values (xxxx...)
+这个错误是由于使用PyMatting方法处理遮罩边缘时，遮罩面积过大或者过小引起的。     
+
+解决方法：
+* 请调整参数，改变遮罩有效面积。或者换用其他的方法处理边缘。
+
+### requests.exceptions.ProxyError: HTTPSConnectionPool(xxxx...)
+出现这个错误，请检查网络环境。
+
+
 ## 如何找到本节点组
 * 在ComfyUI画布点击右键 - Add Node, 找到 "😺dzNodes"。    
 ![image](image/node-menu.png)