From 56bb8458a3bee896717d3aeb60f8047e9dd0880b Mon Sep 17 00:00:00 2001 From: Leon Date: Wed, 24 Nov 2021 09:21:39 +0800 Subject: [PATCH] docs: readme --- README.md | 42 ++++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 9a190fb..a53268d 100644 --- a/README.md +++ b/README.md @@ -67,13 +67,34 @@ ## 目录 -- `app.config.js`: app 基础配置 -- `electron.builder.js`: 打包配置 -- `public`：静态资源文件夹 -- `config`：webpack pack、node modules -- `src/background.ts`：Electron Background Process - -## 命令 + ├── app.config.js // 基础配置 + ├── babel.config.js // babel 配置 + ├── build // 打包输出文件夹 + │ ├── binary // 二进制打包输出 + │ └── bundle // renderer main打包源输出 + ├── config // 打包配置 + │ ├── dev.js // 开发监听启动 + │ ├── dist.js // 发布打包源 + │ ├── webpack.main.js // background 编译 + │ └── webpack.renderer.js // renderer 编译 + ├── electron.builder.js // electron.builder 二进制打包配置 + ├── global.d.ts // typescript 全局声明 + ├── lint-staged.config.js // git commit 钩子 + ├── public // 静态文件 + ├── src // 页面源 + │ ├── App.less // 入口样式 + │ ├── assets // 资源文件 + │ ├── background.ts // electron background + │ ├── config // 应用配置 + │ ├── hook // hook + │ ├── index.tsx // entry file + │ ├── layout // 布局 + │ ├── type // 声明文件 + │ └── utils // 工具 + └── tsconfig.json // typescript 配置 + └── tslint.json // tslint 配置 + +## 使用 ### 安装 @@ -81,6 +102,8 @@ ### 脚本 +如下脚本命令，也可以把 **npm run** 改为 **yarn** 执行： + - 开发服务启动 - `npm run serve` - Lint 格式化 - `npm run lint` - 源构建输出 - `npm run dist` @@ -90,11 +113,6 @@ - 构建 Mac 二进制 - `npm run build:mac` - 构建 Linux 二进制 - `npm run build:linux` -### 输出 - -- bundle 构建输出 - `./build/bundle` -- 二进制构建输出 - `./build/binary` - ## 赞赏 ![赞赏](https://raw.githubusercontent.com/funnyzak/tts-now/master/public/_docs/assets/img/coffee.png)