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