Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
liby authored and VickScarlet committed Sep 5, 2021
1 parent 0195c85 commit 7e808e1
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 2 deletions.
46 changes: 46 additions & 0 deletions README-zh_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# lifeRestart

![Discord](https://img.shields.io/discord/883382868427014255?color=%23FEE75C&label=Discord&logo=discord&logoColor=white&style=for-the-badge)

[English](./README.md) | 简体中文

## 简介

- Game Life Restart

## 使用

1. 下载项目代码。

```bash
git clone https://github.com/VickScarlet/lifeRestart.git my-project
cd my-project
```

2. 进入目录安装依赖。

```bash
yarn install
```

或者

```bash
npm install
```

3. 启动本地服务器。

```bash
yarn dev
```

或者

```bash
npm run dev
```

4. 启动完成后会自动打开浏览器访问 [http://localhost:8081/view/index.html](http://localhost:8081/view/index.html)

> 更多信息请参考 [官网文档](https://liferestart.syaro.io/)
46 changes: 44 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,46 @@
# lifeRestart
Game Life Restart

![Discord](https://img.shields.io/discord/883382868427014255?color=%23FEE75C&label=Discord&logo=discord&logoColor=white&style=for-the-badge)
![Discord](https://img.shields.io/discord/883382868427014255?color=%23FEE75C&label=Discord&logo=discord&logoColor=white&style=for-the-badge)

English | [简体中文](./README-zh_CN.md)

## Introduction

- Game Life Restart

## Usage

1. Clone project code.

```bash
git clone [email protected]:VickScarlet/lifeRestart.git my-project
cd my-project
```

2. Installation dependence.

```bash
yarn install
```

Or

```bash
npm install
```

3. Start local server.

```bash
yarn dev
```

Or

```bash
npm run dev
```

4. After the startup is complete, will automatically open a browser and visit [http://localhost:8081/view/index.html](http://localhost:8081/view/index.html).

> More instructions at [documentation](https://liferestart.syaro.io/)

0 comments on commit 7e808e1

Please sign in to comment.