1

README.md

@@ -1,18 +1,73 @@
-# Vue 3 + TypeScript + Vite
+# 公司内部用演示程序
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+该项目是一个公司内部用的演示程序，部署在大屏上用于展示公司的产品和服务，支持配置显示的内容页面和显示比例等。
 
-## Recommended IDE Setup
+## 技术栈
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+### 前端核心技术
 
-## Type Support For `.vue` Imports in TS
+- **Vue 3**：使用 Composition API
+- **Electron**：跨平台桌面应用框架
+- **TypeScript**：类型检查
+- **Vite**
+- **SCSS**
+- **Vue Router**
+- **Ant Design Vue**
+- **Monaco Editor**：代码编辑器，用于配置文件编辑
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+### 开发工具
 
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+- **TypeScript**：类型检查
+- **Vite**：开发服务器和构建工具
+- **Electron Builder**：应用打包工具
+- **Sass**：CSS预处理器
 
-1. Disable the built-in TypeScript Extension
-   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+## 项目结构
+
+```
+src/
+├── assets/           # 静态资源文件
+├── components/       # 组件
+│   ├── AppList.vue   # 应用列表组件
+│   └── AppListItem.vue # 应用列表项组件
+├── config/           # 配置文件
+│   └── version.json  # 版本信息
+├── model/            # 类型定义
+│   └── App.ts        # 应用模型接口
+├── router/           # 路由配置
+│   └── index.ts      # 路由定义
+├── views/            # 页面视图
+│   ├── About.vue     # 关于页面
+│   ├── Config.vue    # 配置页面
+│   ├── Error.vue     # 错误页面
+│   ├── Expand.vue    # 扩展页面
+│   ├── Hello.vue     # 欢迎页面
+│   ├── Loading.vue   # 加载页面
+│   └── Main.vue      # 主页面
+├── App.vue           # 根组件
+├── main.ts           # 入口文件
+└── vite-env.d.ts     # Vite环境类型定义
+```
+
+## 开发与构建
+
+### 开发命令
+
+```bash
+# 启动开发服务器
+npm run dev
+```
+
+### 构建命令
+
+```bash
+# 构建Windows版本, 输出到release目录
+npm run build
+```
+
+### 类型检查
+
+```bash
+# 执行TypeScript类型检查
+npm run typecheck
+```