📖 update(docs): 更新 README 及项目资源说明文档

This commit is contained in:
BTMuli
2023-04-07 17:02:38 +08:00
parent 654a673097
commit a9a6eda4ae
2 changed files with 24 additions and 6 deletions

View File

@@ -2,12 +2,12 @@
Author: 目棃
Date: 2023-03-05
Description: 说明文档
Update: 2023-04-03
Update: 2023-04-07
---
> 本文档 [`Front-matter`](https://github.com/BTMuli/Mucli#FrontMatter) 由 [MuCli](https://github.com/BTMuli/Mucli) 自动生成于`2023-03-05 14:41:55`
>
> 更新于 `2023-04-03 00:03:38`
> 更新于 `2023-04-07 16:56:13`
![](https://img.shields.io/github/last-commit/BTMuli/Tauri.Genshin?style=for-the-badge) ![](https://img.shields.io/github/commits-since/BTMuli/Tauri.Genshin/latest?include_prereleases&style=for-the-badge) ![](https://img.shields.io/github/v/release/BTMuli/Tauri.Genshin?include_prereleases&style=for-the-badge) ![](https://img.shields.io/github/license/BTMuli/Tauri.Genshin?style=for-the-badge)
@@ -45,6 +45,7 @@ Tauri 练手项目
- [Snap.Hutao](https://github.com/DGP-Studio/Snap.Hutao)
- [米游社](https://www.miyoushe.com/ys/)
- [原神](https://yuanshen.com/)
## 相关文档
@@ -55,13 +56,13 @@ Tauri 练手项目
## 开发
```bash
npm run tauri dev
npm run dev
```
## 构建
```bash
npm run tauri build
npm run build
```
# License
@@ -73,4 +74,5 @@ npm run tauri build
# Contributors
- [BTMuli](https://github.com/BTMuli)
- [舰队的偶像岛风酱!](https://github.com/frg2089)
- [jerry765](https://github.com/jerry765)

View File

@@ -2,12 +2,12 @@
Author: 目棃
Date: 2023-03-10
Description: 项目资源说明
Update: 2023-03-24
Update: 2023-04-07
---
> 本文档 [`Front-matter`](https://github.com/BTMuli/Mucli#FrontMatter) 由 [MuCli](https://github.com/BTMuli/Mucli) 自动生成于`2023-03-10 22:05:44`
>
> 更新于 `2023-03-24 15:30:17`
> 更新于 `2023-04-07 17:01:56`
## 说明
@@ -83,3 +83,19 @@ Update: 2023-03-24
### 格式说明
- 卡牌图标:`source/gcg/card/${cardType}/${cardName}.webp`420x72032位深度
## 素材日历相关
### JSON 数据
为米游社观测枢 API 获取的 JSON 数据,格式参见 [calendar.ts](https://github.com/BTMuli/Tauri.Genshin/blob/master/src/plugins/Mys/interface/calendar.ts)。
### 图像资源
- [素材日历|米游社观测枢](https://bbs.mihoyo.com/ys/obc/channel/map/231)
### 格式说明
> `sourceType` 有 `character`、`weapon`、`material` 三种类型,`sourceName` 为对应的名称。
- 素材图标:`source/calendar/${sourceType}/${sourceName}.webp`128x12832位深度