update readme

Author: jiayuzhang128

README.md

@@ -4,6 +4,8 @@
 
 本仓库提供基于ORB特征点的图像相似度估计。
 
+中文|[English](./README_en.md)
+
 ## 技术路线图
 
 ![roadmap](./images/roadmap.png)
@@ -100,7 +102,7 @@ python .\main.py -s .\data\sample\sample4.png -q .\data\query\ -o .\output\
 
 ## 使用pyinstaller封装py脚本（可选）
 
-若需要修改py脚本文件，再次封装是，需要使用pyinstaller包
+若需要修改py脚本文件，再次封装时，需要使用pyinstaller包
 
 [pyinstaller文档](https://pyinstaller.org/en/stable/index.html)
 

README_en.md

@@ -0,0 +1,111 @@
+# Image similarity estimation
+
+![platform](https://img.shields.io/badge/platform-windows%20x86__64-blue) ![language](https://img.shields.io/badge/language-python-blue)
+
+本仓库提供基于ORB特征点的图像相似度估计。
+
+English|[中文](./README.md)
+
+## Roadmap
+
+![roadmap](./images/roadmap_english.png)
+
+## Dependency
+
++ python 3.7.16
+
++ numpy 1.21.6
+
++ opencv-python 4.7.0.72
+
++ matplotlib 3.5.3
+
++ pyinstaller 5.9.0
+
+> test platform：Window10 x86_64
+
+## Results
+
+### sample image
+
+|sample1|sample2|sample3|sample4|
+|---|---|---|---|
+|<img src="./data/sample/sample1.png" height="150"/>|<img src="./data/sample/sample2.png" height="150"/>|<img src="./data/sample/sample3.png" height="150"/>|<img src="./data/sample/sample4.png" height="150"/>|
+
+### query image
+
+|col1|col2|col3|col4
+|---|---|---|---|
+|<img src="./data/query/painting1.png" height="150"/>|<img src="./data/query/painting2.png" height="150"/>|<img src="./data/query/painting3.png" height="150"/>|<img src="./data/query/painting4.png" height="150"/>|
+|<img src="./data/query/painting5.png" height="150"/>|<img src="./data/query/painting6.png" height="150"/>|<img src="./data/query/painting7.png" height="150"/>|<img src="./data/query/painting8.png" height="150"/>|
+|<img src="./data/query/painting9.png" height="150"/>|<img src="./data/query/painting10.png" height="150"/>|<img src="./data/query/painting11.png" height="150"/>|<img src="./data/query/painting12.png" height="150"/>|
+
+### 结果与保存
+
+> Take sample4 as an example
+
++ matches
+
+![matches](output/FinalMatchesWithSimilarity.png)
+
++ keypoints
+
+![keypoints](output/FinalKeypointsWithSimilarity.png)
+
++ best match
+
+|sample|query|simlarity(%)|
+|---|---|---|
+|<img src="./data/sample/sample4.png" height="150"/>|<img src="./data/query/painting1.png" height="150"/>|27.00|
+
++ The result is saved in the specified output path with the following structure:
+
+```text
+├─descriptors
+├─keypoints
+└─resize
+```
+
+## Usage
+
+If you already have python enviroment， run by `py script` is recommended，otherwise run by `exe` is recommend.
+
+### using py scripts
+
++ terminal/cmd navigate into project directory, then execute：
+
+```bat
+python .\main.py -s .\data\sample\sample4.png -q .\data\query\ -o .\output\
+```
+
++ check help：
+
+```bat
+.\main.py -h
+```
+
+### using exe
+
++ terminal/cmd navigate into `app` and execute:
+
+```bat
+.\imageSim.exe -s ..\data\sample\sample4.png -q ..\data\query\ -o ..\output\
+```
+
+or directly run `run.bat` in terminal/cmd
+
+```bat
+.\run.bat
+```
+
+## Package py scripts using pyinstaller（optional）
+
+If you need to modify the py script file, you need to use the pyinstaller package when packaging it again.
+
+[pyinstaller docs](https://pyinstaller.org/en/stable/index.html)
+
+After modification, run the 'createEXE.bat' file directly to generate the 'app' folder in the directory where the py script is located. The exe file is stored in 'app'.
+
+## Acknowledgements
+
+Thanks to adumrewal and whoisraibolt for opening source of their excellent work [SIFTImageSimilarity](https://github.com/adumrewal/SIFTImageSimilarity)and [Feature-Detection-and-Matching](https://github.com/whoisraibolt/Feature-Detection-and-Matching).