From 83757d613796bad296e6b205c9047a41e8711980 Mon Sep 17 00:00:00 2001
From: Krxk <1246924370@qq.com>
Date: Fri, 3 Nov 2023 05:08:25 +0800
Subject: [PATCH] Update README.md

---
 README.md | 52 +++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 41 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index f0eaef0..debedf9 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,49 @@
 # README
 
-## About
+## ❔关于
 
-This is the official Wails Vue-TS template.
+本项目是Scut校园网路由器管理客户端，基于 Vue3 + go + wails v3。
 
-You can configure the project by editing `wails.json`. More information about the project settings can be found
-here: https://wails.io/docs/reference/project-config
+## ▶编译前端
 
-## Live Development
+frontend目录是一个vue3项目，请先运行
 
-To run in live development mode, run `wails dev` in the project directory. This will run a Vite development
-server that will provide very fast hot reload of your frontend changes. If you want to develop in a browser
-and have access to your Go methods, there is also a dev server that runs on http://localhost:34115. Connect
-to this in your browser, and you can call your Go code from devtools.
+```
+npm install
+```
 
-## Building
+安装前端相关依赖。
 
-To build a redistributable, production mode package, use `wails build`.
+然后运行
+
+```
+npm build
+```
+
+构建前端。
+
+## ▶编译应用程序
+
+Wails 将利用*Vite*构建前端，故需要利用npm安装**Vite**，接着在MINGW64(安装git时会自动安装)运行
+
+```shell
+wails dev
+```
+
+完成首次环境配置。
+
+此后，可通过
+
+```sh
+wails build
+```
+
+完成应用程序构建。
+
+## ❗注意
+
+若出现首页Avatar无法读取的情况，可先删除
+
+> frontend/dist/MyAvatar.jpg
+
+然后重新构建。