docs: separate documentation from README.md
This commit is contained in:
1 parent
4957acd1a8
commit
ddbf691205
5 files changed
+114
-110
No files matched your search
@@ -0,0 +1,41 @@
|
||||
# Getting Started
|
||||
|
||||
## Clone project
|
||||
|
||||
You can easily clone a repository with just the npm command. (Recommend)
|
||||
|
||||
```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.
|
||||
|
||||
```shell
|
||||
$ git clone https://github.com/jooy2/vutron <PROJECT_NAME>
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
After cloning the project, run the following command in the terminal:
|
||||
|
||||
```shell
|
||||
# via npm
|
||||
$ npm i
|
||||
|
||||
# via yarn (https://yarnpkg.com)
|
||||
$ yarn install
|
||||
|
||||
# via pnpm (https://pnpm.io)
|
||||
$ pnpm i
|
||||
|
||||
# via cnpm (https://github.com/cnpm/cnpm)
|
||||
$ cnpm i
|
||||
```
|
||||
|
||||
## Run in development environment
|
||||
|
||||
```shell
|
||||
$ npm run dev
|
||||
```
|
||||
Reference in new issue
Block a user