Simple tutorial

README.md

@@ -3,7 +3,7 @@
 
 A cross-platform GUI for [Proxmark3](https://github.com/Proxmark/proxmark3) client
 
-[中文介绍](README/doc/README_zh_CN.md)
+[中文介绍](doc/README/README_zh_CN.md)
 
 ***
 
@@ -26,9 +26,9 @@ A cross-platform GUI for [Proxmark3](https://github.com/Proxmark/proxmark3) clie
 ***
 
 ## Preview
-![preview](README/img/preview.png)  
+![preview](doc/README/preview.png)  
 
-[more previews](README/doc/previews.md)  
+[more previews](doc/preview/previews.md)  
 
 ***
 
@@ -65,6 +65,10 @@ Great thanks to him.
     ./Proxmark3GUI
 
 ***
+## Tutorial
+
+[1.Quickstart](doc/tutorial/Quickstart/quickstart.md)
+***
 
 ## Update Log:
 

README/doc/previews.md

@@ -1,20 +0,0 @@
-## Previews
-
-Raw Command:  
-![raw_command](../img/raw_command.gif) 
-
-Mifare Nested Attack:  
-![nested_attack](../img/mf_nested_attack.gif)  
-
-Mifare Load File:  
-![mf_loadfile](../img/mf_loadfile.gif)  
-
-Mifare Edit File:  
-![mf_editfile](../img/mf_editfile.gif)  
-
-Mifare Trailer Decoder:  
-![mf_trailer](../img/mf_trailer.gif)
-
-Dock Widget:  
-![dock1](../img/dock1.png)  
-![dock2](../img/dock2.png)  

doc/README/README_zh_CN.md

@@ -26,9 +26,9 @@
 ***
 
 ## 预览图
-![preview](../img/preview_zh_CN.png)  
+![preview](preview_zh_CN.png)  
 
- [更多预览](../doc/previews.md)  
+ [更多预览](../preview/previews.md)  
 
 ***
 
@@ -64,7 +64,9 @@ release页面中有含客户端的GUI。这个GUI也可以搭配你自己的客
     ./Proxmark3GUI
 
 ***
-
+## 教程
+[1.快速上手](../tutorial/Quickstart/quickstart_zh_CN.md)
+***
 ## 更新日志:
 
 ### V0.2.2

doc/preview/previews.md

@@ -0,0 +1,20 @@
+## Previews
+
+Raw Command:  
+![raw_command](raw_command.gif) 
+
+Mifare Nested Attack:  
+![nested_attack](mf_nested_attack.gif)  
+
+Mifare Load File:  
+![mf_loadfile](mf_loadfile.gif)  
+
+Mifare Edit File:  
+![mf_editfile](mf_editfile.gif)  
+
+Mifare Trailer Decoder:  
+![mf_trailer](mf_trailer.gif)
+
+Dock Widget:  
+![dock1](dock1.png)  
+![dock2](dock2.png)  

doc/tutorial/Quickstart/quickstart.md

@@ -0,0 +1,44 @@
+# Quickstart
+
+***
+**On Windows**
+***
+## Use GUI with included client
+(1) Download the GUI with included client on [release](https://github.com/wh201906/Proxmark3GUI/releases) page  
+![](download_withclient.png)  
+
+(2) Extract the .7z file to a path. The target path should not contain non-ASCII characters  
+![](pm3guipath.png)  
+
+(3) Open Proxmark3GUI.exe in the GUI folder, then select the language and click "OK". Now you can use it  
+![](pm3gui.png)  
+![](language.png)  
+
+## Use the GUI with your own client
+(1) Download the standalone GUI on [release](https://github.com/wh201906/Proxmark3GUI/releases) page  
+![](download.png)  
+
+(2) Extract the .7z file to a path. The target path should not contain non-ASCII characters. Make sure the client path and the GUI path are different.  
+
+(3) Open the GUI. Input the client path in the "Client Path" editbox on the top of the main window.  
+![](pm3path.png)  
+
+(4) Go to "Settings" panel. Input the config file path which matching the client you use.  
+![](configpath.png)  
+
+(5) If setup.bat is required, input the script path in the "Preload script path" editbox.
+![](preloadpath.png)  
+
+(6) If using RRG/Iceman repo, input "-p \<port\> -f" in the "Start arguments" editbox.
+![](args.png)  
+
+***
+**On Linux**
+***
+(1) Build the GUI by following the instructions on [README](../../../README.md)  
+(2) Config the GUI with the same steps of "On Windows"->"Use the GUI with your own client"  
+(3) You might need to change "\<port\>" to "/dev/\<port\>" in "Settings"->"Start arguments" editbox  
+![](args_linux.png)  
+
+(4) If you are using Raspbian(Raspberry OS), you might need to check "Keep the client active even the PM3 hardware is disconnected." in the "Steeings" panel  
+![](keep.png)  

doc/tutorial/Quickstart/quickstart_zh_CN.md

@@ -0,0 +1,48 @@
+# 快速上手
+
+***
+**Windows用户**
+***
+## 使用包含客户端的版本
+(1) 直接下载[release](https://github.com/wh201906/Proxmark3GUI/releases)当中包含客户端的版本即可  
+![](download_withclient.png)  
+（例如Vx.x.x-win-Officialclient.7z或Vx.x.x-win-RRGclient.7z，前者为官方客户端，后者为冰人版/RRG客户端）  
+
+(2) 下载完成后将压缩包内所有内容解压到不含中文的路径当中  
+![](pm3guipath.png)  
+
+(3) 双击GUI目录下的Proxmark3GUI.exe，选择语言，点击OK，即可正常运行  
+![](pm3gui.png)  
+![](language_zh_CN.png)  
+***
+
+## 使用现有客户端
+(1) 下载[release](https://github.com/wh201906/Proxmark3GUI/releases)当中不包含客户端的版本  
+![](download.png)  
+
+(2) 解压到不含中文的路径当中  
+（注意，GUI所在目录和PM3客户端所在目录不能相同）  
+
+(3) 双击打开，选择语言，在顶端“客户端路径”当中填入proxmark3.exe的路径  
+![](pm3path_zh_CN.png)  
+
+(4) 进入“设置”面板，根据自己使用的客户端类型（官方版/冰人版）选择正确的配置文件  
+（./config/config_official.json或./config/config_rrgv4.13.json）  
+![](configpath_zh_CN.png)  
+
+(5) 若客户端启动时需要双击setup.bat启动，而setup.bat内会设置客户端运行时的环境变量，则需要在“预加载脚本路径”当中填入setup.bat的路径  
+![](preloadpath_zh_CN.png)  
+
+(6) 若使用的是冰人固件，则可能需要在“启动参数”当中填入“-p \<port\> -f”  
+![](args_zh_CN.png)  
+
+***
+**Linux用户**
+***
+(1) 参考[README](../../README/README_zh_CN.md)当中的编译步骤手动编译Proxmark3GUI  
+(2) 参考“Windows用户”->“使用现有客户端”的(2)~(6)步进行配置  
+(3) “设置”->“启动参数”当中可能需要将“\<port\>”改为“/dev/\<port\>”  
+![](args_linux_zh_CN.png)  
+
+(4) 若使用树莓派Raspbian系统且连接成功若干秒后PM3会自动断开，则需要在“设置”面板中勾选“在PM3断开后保持客户端运行”  
+![](keep_zh_CN.png)