Merge pull request #68 from oceanlvr/main

docs(readme): add quick-start preview

README.md

@@ -18,7 +18,7 @@ The repo contains only the most basic files, dependencies and functionalities to
 
 You need a basic understanding of `Electron` and `Vite` to get started. But that's not mandatory - you can learn almost all the details by reading through the source code. Trust me, this repo is not that complex. 😋
 
-## Run Setup
+## Quick Start
 
   ```bash
   # clone the project
@@ -34,6 +34,8 @@ You need a basic understanding of `Electron` and `Vite` to get started. But that
   npm run dev
   ```
 
+![quick-start](packages/renderer/public/images/quick-start.gif)
+
 ## Directory
 
 A `dist` folder will be generated everytime when `dev` or `build` command is executed. File structure of `dist` is identical to the `packages` directory to avoid any potential path calculation errors.

README.zh-CN.md

@@ -20,7 +20,7 @@
 
 模板的具体实现细节我相信你看两遍源码就能把它吃透了 😋
 
-## 运行项目
+## 快速开始
 
   ```bash
   # clone the project
@@ -36,6 +36,8 @@
   npm run dev
   ```
 
+![quick-start](packages/renderer/public/images/quick-start.gif)
+
 ## 目录结构
 
   一旦启动或打包脚本执行过，会在根目录产生 **`dist` 文件夹，里面的文件夹同 `packages` 一模一样**；在使用一些路径计算时，尤其是相对路径计算；`dist` 与 `packages` 里面保持相同的目录结构能避开好多问题