From 55e373c2d7f63acd8eb13211259c135309d38287 Mon Sep 17 00:00:00 2001 From: leejooy96 Date: Tue, 27 Dec 2022 11:56:54 +0900 Subject: [PATCH] docs: update getting started document --- docs/getting-started.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 3ed291c..659162a 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2,15 +2,25 @@ ## Clone project -You can easily clone a repository with just the npm command. (Recommend) +### Method 1: `npm init` (Recommend) + +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. +The above method will not create unnecessary documentation and .github related files for your project. -OR, Clone this repo using below command. +### Method 2: Use this template + +Click **[Use this template](https://github.com/jooy2/vutron/generate)** to instantly create your own project. + +This method creates a repository on GitHub immediately, but you will need to clone the project locally before you can use it. + +### Method 3: Clone this repository + +Clone this repo using below command. This method is suitable for direct contributions to the Vutron repository. ```shell $ git clone https://github.com/jooy2/vutron @@ -33,6 +43,12 @@ $ pnpm i ## Run in development environment +Applications in the development environment run through **[Vite](https://vitejs.dev)**. + ```shell $ npm run dev ``` + +If your application doesn't appear after running command line commands, you may need to review if the default port is being used by another app. + +Vite uses port `5173` by default.