Skip to content

Commit

Permalink
Update get.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lqzhgood authored Nov 18, 2023
1 parent d0d6e50 commit 0e9c722
Showing 1 changed file with 26 additions and 14 deletions.
40 changes: 26 additions & 14 deletions docs/guide/use/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

## 如何启动项目

项目中可能并不会 **明确** 说明如何启动项目, 并且大部分项目并不会打包为开箱即用的 `"exe"`.
大部分项目并不会打包为开箱即用的 `"exe"`

如果您非程序员, 下面将简单讲解 **通用** 启动方式

Expand Down Expand Up @@ -64,32 +64,44 @@ Github 为例, 点击下图中 `Download ZIP` 即可下载当前项目源码
// 结构示例
// 由于历史原因,可能有部分 Get 输出并未遵循此规则,慢慢重构吧
- data <--- 资源文件
- MobilqQQ-lqzh-20230101
- images
- videos
...
- dist
- MobileQQ-lqzh-20230101.json <--- 数据文件
- MobileQQ-lqzh-20230101.json <--- 数据文件
- data <--- 资源文件
- MobilqQQ-lqzh-20230101
- images
- videos
...
- _temp <--- 输出过程中的一些信息,如下载错误的文件等
- DOWN_ERROR.json
- XXXX.json
- _temp <--- 输出过程中的一些信息,如下载错误的文件等
- DOWN_ERROR.json
- XXXX.json
```

- `数据文件`

[Shmily-Msg](./msg/schema.md) 格式的 JSON 文件,内容是从数据(库)导出的消息内容。

- 尽量导出消息相关的所有数据而非所需数据, 这样会给其他人带来帮助, 也便于丰富更多信息
- 尽量补充完整信息, 如 自定义表情, 补充 表情包名称 与 描述, 对于统计来说更准确全面

<details>
<summary> 给开发者的一些建议</summary>
- 尽量导出消息相关的所有数据而非所需数据, 这样会给其他人带来帮助, 也便于丰富更多信息
- 尽量补充完整信息, 如 自定义表情, 补充 表情包名称 与 描述, 对于统计来说更准确全面

</details>

- `资源文件`

消息相关的静态资源文件,如图片、表情、视频等

<details>
<summary> 给开发者的一些建议</summary>

- 对于外链的资源,建议能爬下来的资源(如图片)都本地化, 过个几年这些 URL 都打不开了
- 对于外链的资源,建议能爬下来的资源(如图片)都本地化, 过个几年这些 URL 都打不开了

</details>



### 5. 展示

Expand Down

0 comments on commit 0e9c722

Please sign in to comment.