doc: 文档完善

README.md

@@ -1,3 +1,81 @@
 # game-frame-template
 
-游戏父窗口模板
+游戏父窗口模板
+
+## 运行启动
+
+> 需要先安装node
+
+### 安装依赖
+
+npm 安装
+
+```bash
+npm i
+```
+
+或者 使用yarn
+```bash
+yarn
+```
+
+### 运行父窗口(本程序)
+
+```bash 
+npm run dev
+```
+或者
+```bash
+yarn dev
+```
+
+### 运行游戏
+
+开启游戏服务，运行后，修改 index.html 中 iframe 的 src 为游戏的页面地址，示例如下：
+
+```html
+<iframe id="iframe" src="http://localhost:5500/dist/" frameborder="0" class="d-block"></iframe>
+```
+
+**注意**：本地环境与服务器生产环境的切换
+
+## 文件目录说明
+
+重点关注src目录下的js文件：
+
+```
+.
+├── config.js
+├── dom.js
+├── frame.js
+├── index.js
+└── message.js
+```
+
++ config.js，各个游戏的时间、事件、分值等配置信息，首先需要修改，注意验证总分、总次数
++ dom.js，测试、调试用的dom按钮等，正式环境不需要
++ frame.js，设置iframe尺寸，监听接受消息，发送消息
++ index.js 入口文件，正常环境将initDom相关内容删除
++ message.js，处理、生成各种事件对应的data数据
+
+## 部署
+
+**部署之前，一定要将iframe的src改为生产路径**
+**部署之前，一定要将iframe的src改为生产路径**
+**部署之前，一定要将iframe的src改为生产路径**
+
+### 构建命令
+
+```bash
+npm run build
+```
+
+或者
+
+```bash
+yarn build
+```
+
+### 上传服务器
+
+将dist目录下的内容上传至服务器目录下