From 342b280913adccac1fb272983cdf2d92c15b69cc Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Thu, 12 Mar 2026 08:35:52 +0000
Subject: [PATCH] Update README.md

---
 README.md | 130 +++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 125 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index b803fad..4bb60bc 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,125 @@
-# uni-app
-
-#### 介绍
-定制化的基于uview-plus的uni-app基础框架
-
+
+
+# uni-app
+
+基于 uview-plus 的 uni-app 基础框架
+
+## 介绍
+
+这是一个定制化的 uni-app 应用开发基础框架，基于 uview-plus UI 组件库构建。框架提供了完整的基础架构，包括常用工具函数、页面模板和 uni-app 生态系统的最佳实践。
+
+## 技术栈
+
+- **前端框架**: uni-app (Vue 3)
+- **UI 组件库**: uview-plus v3
+- **构建工具**: Vite
+- **类型定义**: TypeScript
+
+## 项目结构
+
+```
+uni-app/
+├── src/
+│   ├── comm/                  # 公共工具函数
+│   │   ├── Array.js           # 数组操作工具
+│   │   ├── Comm.js            # 通用工具
+│   │   ├── RegExp.js          # 正则表达式工具
+│   │   ├── String.js          # 字符串操作工具
+│   │   ├── Tools.js           # 常用工具函数
+│   │   └── Tree.js            # 树形结构处理
+│   ├── pages/                 # 页面目录
+│   │   ├── home/              # 首页
+│   │   ├── index/             # 索引页
+│   │   └── order/             # 订单页
+│   ├── static/                # 静态资源
+│   │   ├── logo.png           # 应用Logo
+│   │   └── tabBar/            # TabBar图标
+│   ├── uni_modules/           # uni-app 插件模块
+│   │   └── uview-plus/        # uview-plus UI组件库
+│   ├── App.vue                # 根组件
+│   ├── main.js                # 入口文件
+│   ├── pages.json             # 页面配置
+│   ├── manifest.json          # 应用配置
+│   └── uni.scss               # 全局样式
+├── index.html
+├── jsconfig.json
+├── package.json
+├── pnpm-lock.yaml
+├── tsconfig.json
+└── vite.config.js             # Vite配置
+```
+
+## 快速开始
+
+### 环境要求
+
+- Node.js >= 16.0
+- pnpm >= 7.0
+
+### 安装依赖
+
+```bash
+# 使用 pnpm 安装
+pnpm install
+```
+
+### 运行项目
+
+```bash
+# 运行到 H5
+pnpm dev:h5
+
+# 运行到微信小程序
+pnpm dev:mp-weixin
+
+# 运行到 App
+pnpm dev:app
+```
+
+### 构建项目
+
+```bash
+# 构建 H5
+pnpm build:h5
+
+# 构建微信小程序
+pnpm build:mp-weixin
+
+# 构建 App
+pnpm build:app
+```
+
+## 页面说明
+
+| 页面 | 路径 | 说明 |
+|------|------|------|
+| 首页 | `/pages/home/home` | 应用首页 |
+| 索引页 | `/pages/index/index` | 索引/列表页 |
+| 订单页 | `/pages/order/order` | 订单相关页面 |
+
+## 公共工具
+
+框架在 `src/comm/` 目录下提供了丰富的工具函数：
+
+- **Array.js**: 数组常用操作方法
+- **Comm.js**: 通用工具方法
+- **RegExp.js**: 正则表达式验证与处理
+- **String.js**: 字符串操作工具
+- **Tools.js**: 其他常用工具函数
+- **Tree.js**: 树形数据结构处理
+
+## uview-plus 组件库
+
+本框架集成了 uview-plus v3，这是一套基于 Vue 3 的 uni-app 组件库，提供了丰富的 UI 组件，包括：
+
+- 表单组件：输入框、按钮、选择器等
+- 布局组件：栅格、分割线、间距等
+- 展示组件：图片、头像、徽标等
+- 反馈组件：Toast、Modal、ActionSheet 等
+- 业务组件：商品SKU、倒计时、计数等
+
+详细使用请参考 [uview-plus 官方文档](https://www.uviewplus.com/)。
+
+## 许可证
+
+本项目仅供学习交流使用。
\ No newline at end of file
-- 
Gitee