From 47ddfa4300d621eb2e0fae52a034baa0299883d5 Mon Sep 17 00:00:00 2001 From: leejooy96 Date: Fri, 7 Oct 2022 17:45:42 +0900 Subject: [PATCH] doc: update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c05550a..a2d8f4c 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,8 @@ Quick Start Templates for **[Vite](https://vitejs.dev)** + **[Vue 3](https://vue +--- + ## ⚠️ 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. @@ -24,6 +26,8 @@ The old Vutron using the Webpack5 compiler has been split into the repositories https://github.com/jooy2/vutron-webpack +--- + ## Advantages of use - ✅ You can build immediately without any presets, so you can develop quickly. @@ -54,7 +58,13 @@ https://github.com/jooy2/vutron-webpack ## 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. @@ -65,7 +75,14 @@ $ git clone https://github.com/jooy2/vutron After cloning the project, run the following command in the terminal: ```shell +# via npm $ npm i + +# via yarn +$ yarn install + +# via pnpm +$ pnpm i ``` ## Run in development environment @@ -89,6 +106,8 @@ $ npm run build:mac $ 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? **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.