Update README.md

This commit is contained in:
Masterain
2023-04-19 04:11:57 -07:00
parent f72bd441aa
commit e764fe96de

View File

@@ -1,15 +1,13 @@
# Snap.Hutao.Docs
Documents for [Snap Hutao project](https://github.com/DGP-Studio/Snap.Hutao)
## 使用方法
### 第一次安装
- 安装 [NodeJS 18](https://nodejs.org/en/download/)
- 使用 [GitHub Desktop](https://desktop.github.com/) 克隆本项目或直接使用 git 命令 (`git clone`)
- 在本项目的根目录下`npm install`
### 本地调试
- 在本项目的根目录下执行 `npm run docs:dev`
- 文档会默认运行在`http://localhost:8080`
### 拉取文档
- 使用 GitHub Desktop 或直接使用 git 命令 (`git pull`)
### 提交文档
- 使用 GitHub Desktop 或直接使用 git 命令 (`git commit` & `git push`)
**Please check our [localization document](https://hut.ao/i18n.html) if you want to contribute to the document**
## How to Test
### Fist Time Installation
- Install [NodeJS 18](https://nodejs.org/en/download/)
- Use [GitHub Desktop](https://desktop.github.com/) or Git command to clone this repository (`git clone`)
- Run `npm install` in the root directory of the project
### Local Test
- Run `npm run docs:dev` in the root directory of the project
- The document will run at `http://localhost:8080` by default