docs: 📝 add user guide

CharleeWa · CharleeWa · commit ac09ef910b0d · 2023-04-25T13:58:53.000+08:00
diff --git a/Guide-zh_CN.md b/Guide-zh_CN.md
@@ -0,0 +1,75 @@
+<h1 align="center">使用指南</h1>
+
+简体中文 / [English](./Guide.md)
+
+### 开始使用
+
+本模板采用2023年最新技术栈开发，汇聚了 Vue 生态最新工具流，包括不限于 Vue3、Vite4、Pinia2、Vitest、TypeScript，前端组件库选用接受度最高的 Vant4 （按需使用）进行搭建，开发者可以在此基础模板之上，快速构建移动端应用。
+
+### 包管理器
+
+推荐使用 [pnpm](https://pnpm.io/) 来进行包管理，可以极大地减少install时间, 而且非常节省磁盘空间。
+
+### 目录结构
+
+下面是模板的主要目录结构和一些简要地说明。
+
+```
+├── .husky
+│   └── commit-msg           # commit 信息校验
+|   └── pre-commit           # eslint 代码检验
+├── src
+│   ├── api                  # Api ajax 等
+│   ├── assets               # 本地静态资源
+│   ├── layouts              # 封装布局组件
+│   ├── components           # 业务通用组件和基础布局组件
+│   ├── router               # Vue-Router
+│   ├── store                # Pinia
+│   ├── utils                # 工具库
+│   ├── views                # 业务页面入口和常用模板
+│   ├── App.vue              # Vue 模板入口
+│   └── main.ts              # Vue 入口 JS
+│   └── app.less             # 全局样式
+│   └── env.d.ts             # 全局公用 TypeScript 类型
+├── build/mock               # mock 服务
+├── mock                     # mock 数据
+├── plop-templates           # 代码块生成
+├── public                   # 静态文件
+├── scripts                  # 公共执行脚本
+├── tests                    # 单元测试
+├── plopfile.js              # plop 入口
+├── auto-imports.d.ts        # Vue3 组合式API 类型声明文件
+├── components.d.ts          # 组件自注册类型声明文件
+├── vite.config.ts           # Vite 配置文件
+├── tsconfig.json            # TS 配置文件
+├── index.html               # 浏览器渲染入口
+├── Guide.md                 # 使用指南
+├── README.md                # 简单介绍
+└── package.json             # 项目的依赖
+```
+
+### 本地开发
+
+克隆原仓库的代码到本地。
+
+```bash
+git clone https://github.com/CharleeWa/vue3-vant-mobile.git
+```
+
+进入代码目录，安装项目的依赖。
+
+```bash
+cd vue3-vant-mobile
+
+# with pnpm
+pnpm install
+
+```
+
+> 如果网络状况不佳，可以设置 pnpm 的 npm 加载源，如 pnpm config set registry https://registry.npmmirror.com
+
+完成前面的步骤以后，就可以启动项目，开始进行业务开发了。
+
+```bash
+pnpm dev
+```
diff --git a/Guide.md b/Guide.md
@@ -0,0 +1 @@
+待完成
diff --git a/README-zh_CN.md b/README-zh_CN.md
@@ -14,7 +14,7 @@
   <img src="https://img.shields.io/github/issues-closed/CharleeWa/vue3-vant-mobile" alt="issues" />
 </p>
 
-[English](./README.md) | 简体中文
+简体中文 / [English](./README.md) , [使用指南](./Guide-zh_CN.md) / [English Guide](./Guide.md)
 
 ## 介绍
 
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@
   <img src="https://img.shields.io/github/issues-closed/CharleeWa/vue3-vant-mobile" alt="issues" />
 </p>
 
-English | [简体中文](./README-zh_CN.md)
+English / [简体中文](./README-zh_CN.md) , [使用指南](./Guide-zh_CN.md) / [English Guide](./Guide.md)
 
 ## Introduction
 
