Skip to content

Commit de476e3

Browse files
committed
docs: update README for improved structure and clarity, including section renaming and warnings
1 parent a52c365 commit de476e3

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
Thread-Everything: 一个简单易用的跨平台多端通信工具
2-
==================================================
1+
![Thread-Everything](assets/images/logo.png)
32
[![Deploy MkDocs site to GitHub Pages (using mkdocs gh-deploy)](https://github.com/sergiudm/detectivePi/actions/workflows/mkdocs.yml/badge.svg)](https://github.com/sergiudm/detectivePi/actions/workflows/mkdocs.yml)
43
[![CI](https://github.com/sergiudm/detectivePi/actions/workflows/test.yml/badge.svg)](https://github.com/sergiudm/detectivePi/actions/workflowstest.yml)
54
[![PyPI version](https://badge.fury.io/py/detective-pi.svg)](https://pypi.org/project/Thread-Everything/)
65
![GitHub license](https://img.shields.io/github/license/sergiudm/detectivePi)
76

8-
![Thread-Everything](assets/images/logo.png)
9-
## 介绍
7+
# 简介
108
[Thread-Everything](https://sergiudm.github.io/Thread-Everything/) 提供了易用的 Python API,同时运行*不同*主机上的任何线程,支持Windows, Linux, 可在X86, ARM主机上运行。
119

1210

@@ -17,7 +15,7 @@ Thread-Everything: 一个简单易用的跨平台多端通信工具
1715
- 🎤 智能KTV(手势切歌、氛围灯等)。
1816
- ⚡ 通用GPIO调度器,零代码配置GPIO电平,秒杀大学里各种Lab作业。
1917

20-
## 🏗️ 架构
18+
# 🏗️ 架构
2119
```mermaid
2220
graph TD
2321
subgraph "Resource Manager"
@@ -61,13 +59,13 @@ graph TD
6159
```
6260
本项目的核心模块是一个插件调度器,它负责加载插件并调度插件的执行。插件是一个独立的 Python 模块,它可以实现一些特定的功能,如控制GPIO电平、面部识别等。插件调度器会根据一个统一的配置文件控制插件的加载和执行。插件调度器是一个非常灵活的框架,用户可以根据需求自定义插件的功能。我们提供了视觉后端引擎、音乐引擎和状态机来简化插件的开发。基于现有框架,本项目实现了音乐播放器、手势识别、坐姿检测、GPIO切换器这几个插件。另外,这些功能还可通过通信模块实现P2P通信。
6361

64-
## 运行环境
62+
# 运行环境
6563
| 环境 | 版本 |
6664
| ------ | ---------------------------- |
6765
| OS | Ubuntu22.04, Raspberry Pi OS, Window11, Debian 12|
6866
| Python | 3.10 |
6967

70-
## 🚀 安装
68+
# 🚀 安装
7169
## pip安装
7270
```bash
7371
pip install Thread-Everything
@@ -91,11 +89,12 @@ conda activate <your_env_name>
9189
pip install -r requirements.txt
9290
```
9391

94-
## 🛠️ 使用说明
92+
# 🛠️ 使用说明
93+
>![WARNING]
94+
>注意:不要直接使用`config_template.json`,请根据自己的需求修改`config.json`!
9595
开始前,你需要配置在项目根目录创建一个`config.json`文件,
9696
以下是一个示例,完整的配置文件请参考`config_template.json`
9797
```json
98-
```json
9998
{
10099
"use_pi": false,
101100
"plugin_list": [ # 插件列表
@@ -136,7 +135,7 @@ pip install -r requirements.txt
136135
}
137136
}
138137
```
139-
```
138+
140139
>[!CAUTION]
141140
实际使用时,请删除`config.json`中的所有注释!
142141

0 commit comments

Comments
 (0)