doc: update README.md

This commit is contained in:
leejooy96 committed 2022-10-07 17:45:42 +09:00
1 parent ff0b67b893
commit 47ddfa4300
1 file changed
+20 -1
+20 -1
View File
@@ -16,6 +16,8 @@ Quick Start Templates for **[Vite](https://vitejs.dev)** + **[Vue 3](https://vue
</div> </div>
---
## ⚠️ NOTE: Vutron now uses the Vite compiler!!! ## ⚠️ NOTE: Vutron now uses the Vite compiler!!!
By using the Vite compiler, we achieved our goals of reducing project and bundle size, and improving development environment and build speed. By using the Vite compiler, we achieved our goals of reducing project and bundle size, and improving development environment and build speed.
@@ -24,6 +26,8 @@ The old Vutron using the Webpack5 compiler has been split into the repositories
https://github.com/jooy2/vutron-webpack https://github.com/jooy2/vutron-webpack
---
## Advantages of use ## Advantages of use
- ✅ You can build immediately without any presets, so you can develop quickly. - ✅ You can build immediately without any presets, so you can develop quickly.
@@ -54,7 +58,13 @@ https://github.com/jooy2/vutron-webpack
## Installation ## Installation
Click **[Use this template](https://github.com/jooy2/vutron/generate)** to instantly create your own project. You can easily clone a repository with just the npm command.
```shell
$ npm init vutron
```
OR, Click **[Use this template](https://github.com/jooy2/vutron/generate)** to instantly create your own project.
OR, Clone this repo using below command. OR, Clone this repo using below command.
@@ -65,7 +75,14 @@ $ git clone https://github.com/jooy2/vutron <PROJECT_NAME>
After cloning the project, run the following command in the terminal: After cloning the project, run the following command in the terminal:
```shell ```shell
# via npm
$ npm i $ npm i
# via yarn
$ yarn install
# via pnpm
$ pnpm i
``` ```
## Run in development environment ## Run in development environment
@@ -89,6 +106,8 @@ $ npm run build:mac
$ npm run build:linux $ npm run build:linux
``` ```
The built packages can be found in `dist/release/{version}` location.
### What do I need to do for a multi-platform build? ### What do I need to do for a multi-platform build?
**macOS** is recommended if you want to build multiple platforms simultaneously on one platform. Because it can be configured with just a few very simple settings. **macOS** is recommended if you want to build multiple platforms simultaneously on one platform. Because it can be configured with just a few very simple settings.