diff --git a/README.md b/README.md index d3a2edc..da8f78e 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,15 @@ **English | [็ฎ€ไฝ“ไธญๆ–‡](README.zh-CN.md)** -๐Ÿฅณ Real simple `Electron` + `Vue` + `Vite` boilerplate. +๐Ÿฅณ Really simple `Electron` + `Vue` + `Vite` boilerplate. ## Overview ๐Ÿ“ฆ Out of the box -๐Ÿ’ช Support C/C++ addons -๐Ÿ”ฉ Support Use Electronใ€Node.js API in Renderer-process +๐ŸŽฏ Based on [vue-ts](https://github.com/vitejs/vite/tree/main/packages/create-vite/template-vue-ts) template, less invasive ๐ŸŒฑ Simple directory structure๏ผŒreal flexible +๐Ÿ’ช Support Use Electronใ€Node.js API and in Renderer-process +๐Ÿ”ฉ Support C/C++ native addons ๐Ÿ–ฅ It's easy to implement multiple windows ## Quick Start @@ -27,33 +28,25 @@ npm create electron-vite -![electron-vite-vue.gif](https://github.com/electron-vite/electron-vite-vue/blob/main/packages/renderer/public/electron-vite-vue.gif?raw=true) +![electron-vite-vue.gif](https://github.com/electron-vite/electron-vite-vue/blob/main/public/electron-vite-vue.gif?raw=true) ## Debug -![electron-vite-react-debug.gif](https://github.com/electron-vite/electron-vite-react/blob/main/packages/renderer/public/electron-vite-react-debug.gif?raw=true) +![electron-vite-react-debug.gif](https://github.com/electron-vite/electron-vite-react/blob/main/public/electron-vite-react-debug.gif?raw=true) ## 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. - -```tree -โ”œโ”€โ”€ dist Will be generated following the structure of "packages" directory -| โ”œโ”€โ”€ main -| โ”œโ”€โ”€ preload -| โ””โ”€โ”€ renderer -| -โ”œโ”€โ”€ scripts -| โ”œโ”€โ”€ build.mjs Build script -> npm run build -| โ””โ”€โ”€ watch.mjs Develop script -> npm run dev -| -โ”œโ”€โ”€ packages -| โ”œโ”€โ”€ main Main-process source code -| | โ””โ”€โ”€ vite.config.ts -| โ”œโ”€โ”€ preload Preload-script source code -| | โ””โ”€โ”€ vite.config.ts -| โ””โ”€โ”€ renderer Renderer-process source code -| โ””โ”€โ”€ vite.config.ts +```diff ++ โ”œโ”€โ”ฌ electron ++ โ”‚ โ”œโ”€โ”ฌ main ++ โ”‚ โ”‚ โ””โ”€โ”€ index.ts entry of Electron-main ++ โ”‚ โ””โ”€โ”ฌ preload ++ โ”‚ โ””โ”€โ”€ index.ts entry of Electron-preload + โ”œโ”€โ”ฌ src + โ”‚ โ””โ”€โ”€ main.ts entry of Electron-renderer + โ”œโ”€โ”€ index.html + โ”œโ”€โ”€ package.json + โ””โ”€โ”€ vite.config.ts ``` ## List the modules you may use as far as possible