文档：规范化

wangshaojie1995 · Oct 20, 2024 · 0840845 · 0840845
1 parent dfeb5b3
commit 0840845
Showing 1 changed file with 102 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,26 @@
-# 前言
-项目名：数字人视频播放器  
+<div align="center">
+  <a href="#">
+    <img src="https://raw.githubusercontent.com/LuoXi-Project/LX_Project_Template/refs/heads/main/ui/logo.png" width="240" height="240" alt="点我跳转文档">
+  </a>
+</div>
+
+<div align="center">
+
+# ✨ 洛曦 数字人视频播放器  ✨
+
+[![][python]][python]
+[![][github-release-shield]][github-release-link]
+[![][github-stars-shield]][github-stars-link]
+[![][github-forks-shield]][github-forks-link]
+[![][github-issues-shield]][github-issues-link]  
+[![][github-contributors-shield]][github-contributors-link]
+[![][github-license-shield]][github-license-link]
+
+</div>
+
+## 前言
+
+项目名：洛曦 数字人视频播放器  
 功能：可以通过HTTP API传入需要播放的视频，并排队在web页面自动播放  
 目前支持的项目：  
 - [Easy-Wav2Lip](https://github.com/anothermartz/Easy-Wav2Lip)（gradio API，使用的B站：眠NEON 提供的整合包：[视频传送门](https://www.bilibili.com/video/BV1rS421N71b)）  
@@ -8,36 +29,37 @@
 - [MuseTalk](https://github.com/TMElyralab/MuseTalk)（gradio API，整合包：）  
 - [AniTalker](https://github.com/X-LANCE/AniTalker)（gradio API，使用的B站：刘悦的技术博客 提供的整合包：[下载](https://pan.quark.cn/s/936dcae8aba0#/list/share/56a79e143a8b4877a98a61854e07b229-AI%20Vtuber/741f94606e414157b8d0a021d3a9ca77-%E8%99%9A%E6%8B%9F%E8%BA%AB%E4%BD%93/d31da81a7d64488d812ead76d3bc9f9c-AniTalker), [视频传送门](https://www.bilibili.com/video/BV1rS421N71b)）  
 
-## 环境  
+### 环境  
 python：3.10.10  
 
-# 使用
+## 使用
 
-## 安装依赖
+### 安装依赖
 
 `pip install -r requirements.txt`
 
-## 修改配置文件
+### 修改配置文件
 
 自行根据需求修改`config.json`
 
-## 运行API
+### 运行API
 
 `python api_server.py`
 
-# API
+
+## API
 
 运行后，可以查看API文档：[http://127.0.0.1:8091/docs](http://127.0.0.1:8091/docs)  
 
-## 播放视频
+### 播放视频
 
-### 概述
+#### 概述
 
 - **请求地址:** `/show`
 - **请求类型:** POST
 - **描述:** 传入视频进行播放，可以选择插入索引。
 
-### 请求参数
+#### 请求参数
 
 | 参数名        | 类型   | 是否必需  | 描述                 |
 |--------      |--------|----------|--------------        |
@@ -48,122 +70,141 @@ python：3.10.10
 | insert_index | int    | 是       | 插入索引值，队尾插入：-1，队首插入：0，其他自定义 |
 | move_file    | bool   | 否       | 是否移动合成或指定的视频文件到项目路径内。默认True |
 
-### 响应
+#### 响应
 
 | 参数名  | 类型    | 描述         |
 |--------|-------- |--------------|
 | code   | int     | 状态码，200为成功，小于0为错误代码，大于0为部分成功代码 |
 | msg    | string  | 响应消息，描述请求的处理结果 |
 
-## 跳过当前播放的视频，播放下一个视频
+### 跳过当前播放的视频，播放下一个视频
 
-### 概述
+#### 概述
 
 - **请求地址:** `/stop_current_video`
 - **请求类型:** POST
 - **描述:** 跳过当前播放的视频，播放下一个视频。
 
-### 请求参数
+#### 请求参数
 
 | 参数名        | 类型   | 是否必需  | 描述                 |
 |--------      |--------|----------|--------------        |
 
 
-### 响应
+#### 响应
 
 | 参数名  | 类型    | 描述         |
 |--------|-------- |--------------|
 | code   | int     | 状态码，200为成功，小于0为错误代码，大于0为部分成功代码 |
 | msg    | string  | 响应消息，描述请求的处理结果 |
 
-## 获取队列中非默认视频的个数
+### 获取队列中非默认视频的个数
 
-### 概述
+#### 概述
 
 - **请求地址:** `/get_non_default_video_count`
 - **请求类型:** POST
 - **描述:** 获取队列中非默认视频的个数
 
-### 请求参数
+#### 请求参数
 
 | 参数名        | 类型   | 是否必需  | 描述                 |
 |--------      |--------|----------|--------------        |
 
-### 响应
+#### 响应
 
 | 参数名  | 类型    | 描述         |
 |--------|-------- |--------------|
 | code   | int     | 状态码，200为成功，小于0为错误代码，大于0为部分成功代码 |
 | count  | int     | 队列中非默认视频的个数 |
 | msg    | string  | 响应消息，描述请求的处理结果 |
 
-## 获取视频播放列表数据
+### 获取视频播放列表数据
 
-### 概述
+#### 概述
 
 - **请求地址:** `/get_video_queue`
 - **请求类型:** POST
 - **描述:** 获取视频播放列表数据。
 
-### 请求参数
+#### 请求参数
 
 | 参数名        | 类型   | 是否必需  | 描述                 |
 |--------      |--------|----------|--------------        |
 
 
-### 响应
+#### 响应
 
 | 参数名  | 类型    | 描述         |
 |--------|-------- |--------------|
 | code   | int     | 状态码，200为成功，小于0为错误代码，大于0为部分成功代码 |
 | data   | list     | 存储视频信息的数据列表 |
 | message    | string  | 响应消息，描述请求的处理结果 |
 
-## 删除视频播放列表中指定索引的视频数据
+### 删除视频播放列表中指定索引的视频数据
 
-### 概述
+#### 概述
 
 - **请求地址:** `/del_video_with_index`
 - **请求类型:** POST
 - **描述:** 删除视频播放列表中指定索引的视频数据，返回删除后的视频列表数据
 
-### 请求参数
+#### 请求参数
 
 | 参数名        | 类型   | 是否必需  | 描述                 |
 |--------      |--------|----------|--------------        |
 | index | int    | 是       | 删除索引值，从0开始，0就是首个待播放视频 |
 
-### 响应
+#### 响应
 
 | 参数名  | 类型    | 描述         |
 |--------|-------- |--------------|
 | code   | int     | 状态码，200为成功，小于0为错误代码，大于0为部分成功代码 |
 | data   | list     | 存储视频信息的数据列表 |
 | message    | string  | 响应消息，描述请求的处理结果 |
 
-## 设置相关配置
+### 设置相关配置
 
-### 概述
+#### 概述
 
 - **请求地址:** `/set_config`
 - **请求类型:** POST
 - **描述:** 用于设置相关配置
 
-### 请求参数
+#### 请求参数
 
 | 参数名        | 类型   | 是否必需  | 描述                 |
 |--------      |--------|----------|--------------        |
 | captions_printer_api_url   | string | 否       | 前端 字幕打印机API请求地址，例如：http://127.0.0.1:5500/send_message     |
 
-### 响应
+#### 响应
 
 | 参数名  | 类型    | 描述         |
 |--------|-------- |--------------|
 | code   | int     | 状态码，200为成功，小于0为错误代码，大于0为部分成功代码 |
 | data   | list    | list数据，存储着转换为url路径的视频地址 |
 | msg    | string  | 响应消息，描述请求的处理结果 |
 
-# 更新日志
+
+## 💡 提问的智慧
+
+提交issues前请先阅读以下内容
+
+https://lug.ustc.edu.cn/wiki/doc/smart-questions
+
+## 🀅 开发&项目相关
+
+可以使用 GitHub Codespaces 进行在线开发：
+
+[![][github-codespace-shield]][github-codespace-link]  
+
+
+
+## ⭐️ Star 经历
+
+[![Star History Chart](https://api.star-history.com/svg?repos=Ikaros-521/digital_human_video_player&type=Date)](https://star-history.com/#Ikaros-521/digital_human_video_player&Date)
+
+## 更新日志
 - v0.4.0
     - 视频列表 视频数据改为播放后才删除，意味着你可以通过get_video_queue 获取视频列表的接口 得到当前播放视频的信息（第一个数据就是）
 
@@ -239,3 +280,31 @@ python：3.10.10
     - 初版发布
 
 
+
+[python]: https://img.shields.io/badge/python-3.10+-blue.svg?labelColor=black
+[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-black?style=flat-square
+[github-action-release-link]: https://github.com/actions/workflows/Ikaros-521/digital_human_video_player/release.yml
+[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/Ikaros-521/digital_human_video_player/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
+[github-action-test-link]: https://github.com/actions/workflows/Ikaros-521/digital_human_video_player/test.yml
+[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/Ikaros-521/digital_human_video_player/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
+[github-codespace-link]: https://codespaces.new/Ikaros-521/digital_human_video_player
+[github-codespace-shield]: https://github.com/codespaces/badge.svg
+[github-contributors-link]: https://github.com/Ikaros-521/digital_human_video_player/graphs/contributors
+[github-contributors-shield]: https://img.shields.io/github/contributors/Ikaros-521/digital_human_video_player?color=c4f042&labelColor=black&style=flat-square
+[github-forks-link]: https://github.com/Ikaros-521/digital_human_video_player/network/members
+[github-forks-shield]: https://img.shields.io/github/forks/Ikaros-521/digital_human_video_player?color=8ae8ff&labelColor=black&style=flat-square
+[github-issues-link]: https://github.com/Ikaros-521/digital_human_video_player/issues
+[github-issues-shield]: https://img.shields.io/github/issues/Ikaros-521/digital_human_video_player?color=ff80eb&labelColor=black&style=flat-square
+[github-license-link]: https://github.com/Ikaros-521/digital_human_video_player/blob/main/LICENSE
+[github-license-shield]: https://img.shields.io/github/license/Ikaros-521/digital_human_video_player?color=white&labelColor=black&style=flat-square
+[github-release-link]: https://github.com/Ikaros-521/digital_human_video_player/releases
+[github-release-shield]: https://img.shields.io/github/v/release/Ikaros-521/digital_human_video_player?color=369eff&labelColor=black&logo=github&style=flat-square
+[github-releasedate-link]: https://github.com/Ikaros-521/digital_human_video_player/releases
+[github-releasedate-shield]: https://img.shields.io/github/release-date/Ikaros-521/digital_human_video_player?labelColor=black&style=flat-square
+[github-stars-link]: https://github.com/Ikaros-521/digital_human_video_player/network/stargazers
+[github-stars-shield]: https://img.shields.io/github/stars/Ikaros-521/digital_human_video_player?color=ffcb47&labelColor=black&style=flat-square
+[pr-welcome-link]: https://github.com/Ikaros-521/digital_human_video_player/pulls
+[pr-welcome-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
+[profile-link]: https://github.com/Ikaros-521
+
+