docs: update readme

This commit is contained in:
Ryan Wang
2022-11-23 10:54:34 +08:00
parent a5f707c5ee
commit ab4d63bf90

View File

@@ -1,10 +1,33 @@
# theme-earth
# Earth
Default theme for Halo 2.0(WIP)
Halo 2.0 的默认主题。
## Build theme
主题开发文档可查阅:<https://docs.halo.run/2.0.0-SNAPSHOT/developer-guide/theme/prepare>
> If you are using Windows OS, please install `make` command and execute `make` in Git Bash or WSL.
## 开发
- Execute command `make build` to generate dist folder
- Zip the dist folder and upload to your Halo
```bash
git clone git@github.com:halo-dev/theme-earth.git ~/halo2-dev/themes/theme-earth
```
```bash
cd ~/halo2-dev/themes/theme-earth
```
```bash
pnpm install
```
```bash
pnpm dev
```
## 构建
> 如果你使用的是 Windows 操作系统,请安装 `make` 命令并在 Git Bash 或 WSL 中执行。
```bash
make build
```
然后将 `dist` 目录压缩成 `ZIP` 格式压缩包即可在 Halo 后台上传安装。