update README

README.md

@@ -1,2 +1,111 @@
 # FuckHamSports
+![](https://img.shields.io/badge/license-GPL3.0-blue)  ![](https://img.shields.io/badge/PRs-welcome-green)  ![](https://img.shields.io/badge/java-jdk14%20or%20later-orange)![](https://img.shields.io/badge/issue-welcome-red)
+
 WHU-汉姆-阳光体育代跑图形界面工具-环境打包-即开即用
+
+参考项目：https://github.com/S-Ex1t/SunnyRunningPy
+
+## For users
+
+1. 首先，需要您需要获取您的IMEI码，这是您的身份识别码
+
+**For Android:** 您可以使用Packet Capture或者HttpCanary(黄鸟)进行抓包，安装好app后，请根据app提示安装证书,在进行抓包前请确认已经关闭阳光体育App.以HttpCanary(黄鸟)为例：
+
+​		1.1打开HttpCanary, 进入设置->目标应用->选择阳光体育服务平台(com.aipao.hanmoveschool)
+
+<img src="assets/Screenshot_20210327-101932_HttpCanary.jpg" alt="Screenshot_20210327-101932_HttpCanary" style="zoom: 20%;" /><img src="assets/Screenshot_20210327-102259_HttpCanary.jpg" alt="Screenshot_20210327-102259_HttpCanary" style="zoom:20%;" /><img src="assets/Screenshot_20210327-102305_HttpCanary.jpg" alt="Screenshot_20210327-102305_HttpCanary" style="zoom:20%;" />
+
+​		1.2 回退到主界面，点击右下角纸飞机按钮，开始抓包
+
+<img src="assets/Screenshot_20210327-102823_HttpCanary.jpg" alt="Screenshot_20210327-102823_HttpCanary" style="zoom:20%;" /><img src="assets/Screenshot_20210327-102849.jpg" alt="Screenshot_20210327-102849" style="zoom:25%;" />
+
+​		1.3 关闭跑步App，返回HttpCanary，寻找带有`%7Btoken%7D`的请求接口，打开详情，找到字段`IMEIcode=.....`
+
+<img src="assets/Screenshot_20210327-102931_HttpCanary.jpg" alt="Screenshot_20210327-102931_HttpCanary" style="zoom:20%;" /><img src="assets/Screenshot_20210327-102909_HttpCanary.jpg" alt="Screenshot_20210327-102909_HttpCanary" style="zoom:20%;" />
+
+​		1.4 复制IMEIcode字段, （去掉前缀`IMEIcode=`）
+
+**For IOS:** 据称IOS断网打开APP报错，提示框中会有IMEI
+
+​	
+
+2. 为使用FuckHamSports GUI程序，您需要下载jre/jdk 14或者更高版本。这是java程序执行所依赖且唯一依赖的组件。支持Windows/Linux/MacOS等PC操作系统
+
+   jre下载地址：https://www.java.com/en/download/manual.jsp
+
+   jdk下载地址 ：https://www.oracle.com/java/technologies/javase-downloads.html
+
+
+
+3.  确认第1、2步完成后，请使用jdk/jre为打开方式，双击运行FuckHamSports.jar
+
+![image-20210327104305818](assets/image-20210327104305818.png)
+
+4. 如果运行成功，您应该能够看到类似如下的界面 (Windows10)：
+
+![image-20210327104724880](assets/image-20210327104724880.png)
+
+​		如果未能成功运行，请检测第2步是否成功完成，或根据保存信息网络查询以及向本项目提交`issue`
+
+5.  输入第1步获取的IMEI码，设置好版本(目前最低版本不能低于2.40)、您所希望的大概跑步时间(以秒作为单位)、大致步数。点击`Start`按钮，您应该弹出如下界面
+
+![image-20210327105348635](assets/image-20210327105348635.png)
+
+6. 请耐心等待进度条完成至100%，并查看日志窗口最后的信息，如果是`success`，您应当已经完成了一次跑步。如果是失败或其他信息，请根据日志信息查询原因或提交`issue`
+
+## For developers
+
+本项目IDE 是IntelliJ IDEA version 2020.2.3，使用`apache-maven-3.6.3`管理依赖
+
+<img src="assets/4afbfbedab64034f72b616b4a5c379310a551d0c" alt="img" style="zoom:50%;" />![image-20210327105919183](assets/image-20210327105919183.png)
+
+依赖第三方包为:
+
+```xml
+ <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.11</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-project-info-reports-plugin</artifactId>
+      <version>3.0.0</version>
+      <type>maven-plugin</type>
+    </dependency>
+
+    <dependency>
+      <groupId>org.apache.maven.plugins</groupId>
+      <artifactId>maven-project-info-reports-plugin</artifactId>
+      <version>3.0.0</version>
+    </dependency>
+
+    <!-- https://mvnrepository.com/artifact/org.apache.httpcomponents/httpclient -->
+    <dependency>
+      <groupId>org.apache.httpcomponents</groupId>
+      <artifactId>httpclient</artifactId>
+      <version>4.5.6</version>
+    </dependency>
+
+    <!-- https://mvnrepository.com/artifact/org.json/json -->
+    <dependency>
+      <groupId>org.json</groupId>
+      <artifactId>json</artifactId>
+      <version>20201115</version>
+    </dependency>
+  </dependencies>
+```
+
+### 源代码文件
+
+- `RunFuck.java:`核心代码文件，提供了提交跑步资料并请求相关信息的类，其中`run(String imeiCode,String version)`为完全体功能函数（静态方法），用于快速测试模块是否能够正常工作，GUI组件则使用拆分的`login(String aimeiCode,String aversion);  getUserInfo() ; getRunInfo(int seconds,int steps) ; getEndRunningInfo()`静态方法
+- `MainFrame.java:` 使用`java swing`编写的GUI主界面，用于获取输入
+- `WorkingFrame.java:` 跑步过程中的信息界面，用于绘制进度条和显示当前的请求日志信息。**注意，本界面只有带参数的构造方法`public WorkingFrame(String imeiCode,String version,String seconds,String steps)`；并且构造方法最后会直接调用跑步执行体自动开始代跑**
+- `AboutFrame.java:` 其他信息界面
+- `GUI.java:`程序主入口点，绘制一个`MainFrame`
+
+## License
+
+本项目核心参考于https://github.com/S-Ex1t/SunnyRunningPy，项目遵守GPL3.0免费开源协议

assets/license-GPL3.0-blue

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="96" height="20" role="img" aria-label="license: GPL3.0"><title>license: GPL3.0</title><linearGradient id="s" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="r"><rect width="96" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#r)"><rect width="47" height="20" fill="#555"/><rect x="47" width="49" height="20" fill="#007ec6"/><rect width="96" height="20" fill="url(#s)"/></g><g fill="#fff" text-anchor="middle" font-family="Verdana,Geneva,DejaVu Sans,sans-serif" text-rendering="geometricPrecision" font-size="110"><text aria-hidden="true" x="245" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">license</text><text x="245" y="140" transform="scale(.1)" fill="#fff" textLength="370">license</text><text aria-hidden="true" x="705" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="390">GPL3.0</text><text x="705" y="140" transform="scale(.1)" fill="#fff" textLength="390">GPL3.0</text></g></svg>