docs-新增README.md

README.md

@@ -0,0 +1,51 @@
+## 简介
+
+uniapp Vue3 TypeScript 基础框架
+
+## 特性
+
+- **最新技术栈**：使用 Vue3/vite2 等前端前沿技术开发
+- **TypeScript**: 应用程序级 JavaScript 的语言
+
+## 预览
+
+
+## 安装使用
+
+- 安装依赖
+
+```bash
+pnpm install
+```
+
+- 运行
+
+```bash
+# 其他端请查看 webpage.json script
+pnpm dev:h5
+```
+
+- 打包
+
+```bash
+# 其他端请查看 webpage.json script
+pnpm build:h5
+```
+
+## Git 贡献提交规范
+
+- 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular))
+
+  - `feat` 增加新功能
+  - `fix` 修复问题/BUG
+  - `style` 代码风格相关无影响运行结果的
+  - `perf` 优化/性能提升
+  - `refactor` 重构
+  - `revert` 撤销修改
+  - `test` 测试相关
+  - `docs` 文档/注释
+  - `chore` 依赖更新/脚手架配置修改等
+  - `workflow` 工作流改进
+  - `ci` 持续集成
+  - `types` 类型定义文件更改
+  - `wip` 开发中