更新项目描述

README.md

@@ -1,2 +1,66 @@
-# NsCatGrayQt-Plugin
-About Create NSIS Modern UI Setup by Using Thirdparty UI Library(Qt)
+[>>> 中文](README_ch.md)
+
+# Introduction
+
+Provides a way to create a beautiful, modern Windows platform installation interface.  
+
+Based on Nsis+Qt complete, provide QWidgets,Quick implementation cases. 
+
+**NsCatGrayQt-Plugin structure**
+
+![NsCatGrayQt-Plugin structure](./Algorithm/CatSoftwareStarterStructure.png)
+
+[Reference Item](https://github.com/winsoft666/NSIS-UI-Plugin)
+Innovation and improvement on the shoulders of giants!
+
+---
+
+**NSIS**
+
+Individual from [https://nsis.sourceforge.io/Download](https://nsis.sourceforge.io/Download)  Download and install NSIS, add the system environment variable 'NSIS_DIR' to the NSIS installation directory. 
+
+**Qt**
+
+Because plug-ins use Qt as the interface library by default, you need to install Qt.  
+
+The Qt installation package will add the 'QTDIR' environment variable to the installation directory by default. If it is not added automatically, you need to add it manually. 
+
+---
+
+# Get Started
+
+**Directory description**
+
+```txt
+CatQtPlugins    -- Quick, QWidget code example
+VCRuntimeDLL    -- Place VC++ runtime library files (Debug and Release), Qt interface library is compiled in MD mode by default, runtime needs to rely on VC++ runtime library 
+Include         -- Custom Nsis header files
+module          -- Provide cmake module, NSIS installation function to generate scripts
+NsCatGrayQtCore -- C++ and nsis interaction low-level implementation
+Examples        -- Nsis script package cases
+```
+
+**Compile**
+
+Compilation support CMake, Qmake, can directly compile nSCATgrayqt-plugin directory CMake and Qmake project.  DLL ', 'qtQuickPlugin.dll' Release: 'qtwidgetplugin.dll', 'qtQuickplugin.dll') 
+
+
+**Use python scripts to generate nSIS install and uninstall functions**
+
+```txt
+// module/python/ExtractFiles.py
+ExtractFiles.py [-h] [--builddir BUILDDIR] [--safeuninstall] [--outdir OUTDIR]
+ExtractFiles.py' '--builddir' './' '--safeuninstall'
+
+  --builddir BUILDDIR  Nsis package directory
+  --safeuninstall      Whether the Nsis script is unloaded in safe mode
+  --outdir OUTDIR      Nsis script output path
+```
+
+Using the ExtractFiles script will generate the CatGrayBuildFunc. NSH module (install and uninstall functions) 
+
+![build_CatGrayBuildFunc](./Algorithm/20220621_174108.gif)
+
+# Demonstration
+
+![Algorithm_0](./Algorithm/20220618_111700.gif)

README_ch.md

@@ -49,14 +49,14 @@ Examples        -- nsis脚本打包案例
 ExtractFiles.py [-h] [--builddir BUILDDIR] [--safeuninstall] [--outdir OUTDIR]
 ExtractFiles.py' '--builddir' './' '--safeuninstall'
 
-  --builddir BUILDDIR  Nsis package directory
-  --safeuninstall      Whether the Nsis script is unloaded in safe mode
-  --outdir OUTDIR      Nsis script output path
+  --builddir BUILDDIR  Nsis需要打包的目录路径
+  --safeuninstall      Nsis脚本安全模式下卸载
+  --outdir OUTDIR      Nsis脚本输出路径
 ```
 
 使用ExtractFiles脚本后将会生成CatGrayBuildFunc.nsh模块(安装函数与卸载函数)
 
-
+![build_CatGrayBuildFunc](./Algorithm/20220621_174108.gif)
 
 # 演示