update

README.md

@@ -0,0 +1,48 @@
+
+## 客户端 `Client`前端
+
+### 硬件交互前端服务
+
+#### 介绍
+
+硬件交互前端服务是基于`WebSocket`协议的服务，用于与硬件设备进行通信。
+
+### 环境准备
+
+#### (1) 安装依赖项：
+
+```
+sudo apt-get update
+sudo apt-get upgrade
+sudo apt-get install cmake g++ gcc
+sudo apt-get install python3-pip python3-dev portaudio19-dev libsndfile1
+```
+
+#### (2) 克隆项目到本地并安装依赖：
+
+```
+// 克隆项目到本地 https or ssh
+git clone https://github.com/Irvingao/takway_base.git or git clone git@github.com:Irvingao/takway_base.git
+cd takway_base
+pip install -v -e .
+```
+
+#### (3) 安装板载端环境依赖：
+
+```
+pip install -r requirements/board_requirements.txt
+```
+
+#### (4) 下载相关模型文件:
+
+- [Picovoice：](https://picovoice.ai/docs/quick-start/porcupine-python/)边缘端关键词唤醒模型
+
+```
+目前使用的是`可莉可莉_zh_raspberry-pi_v3_0_0`版本，可以点击网站自行设置替换关键词模型。
+```
+
+#### (5) 启动服务:
+
+```
+python ws_client.py
+```