Commit ·
23c71b8
1
Parent(s): b78364c
docs: update README to emphasize automated installation
Browse files- Add Quick Installation section at the top
- Highlight automated installation scripts
- Move Manual Installation to secondary option
- Update both English and Chinese README files
- Make installation process as simple as possible
- README.md +25 -1
- README_CN.md +25 -1
README.md
CHANGED
|
@@ -39,7 +39,31 @@ This project is based on [OHF-Voice/linux-voice-assistant](https://github.com/OH
|
|
| 39 |
- Reachy Mini robot
|
| 40 |
- Home Assistant with ESPHome integration
|
| 41 |
|
| 42 |
-
###
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 43 |
|
| 44 |
```bash
|
| 45 |
# Clone the repository
|
|
|
|
| 39 |
- Reachy Mini robot
|
| 40 |
- Home Assistant with ESPHome integration
|
| 41 |
|
| 42 |
+
### Quick Installation (Recommended)
|
| 43 |
+
|
| 44 |
+
```bash
|
| 45 |
+
# Clone the repository
|
| 46 |
+
git clone https://github.com/yourusername/reachy_mini_ha_voice.git
|
| 47 |
+
cd reachy_mini_ha_voice
|
| 48 |
+
|
| 49 |
+
# Run the automated installation script
|
| 50 |
+
# For Linux/Mac:
|
| 51 |
+
./install.sh
|
| 52 |
+
|
| 53 |
+
# For Windows:
|
| 54 |
+
powershell -ExecutionPolicy Bypass -File install.ps1
|
| 55 |
+
```
|
| 56 |
+
|
| 57 |
+
The automated installation script will:
|
| 58 |
+
- ✓ Check Python version
|
| 59 |
+
- ✓ Create virtual environment
|
| 60 |
+
- ✓ Install all dependencies
|
| 61 |
+
- ✓ Download wake word models and sound effects
|
| 62 |
+
- ✓ Create configuration file
|
| 63 |
+
- ✓ Check Reachy Mini SDK installation
|
| 64 |
+
- ✓ Check audio devices
|
| 65 |
+
|
| 66 |
+
### Manual Installation
|
| 67 |
|
| 68 |
```bash
|
| 69 |
# Clone the repository
|
README_CN.md
CHANGED
|
@@ -30,7 +30,31 @@
|
|
| 30 |
- Reachy Mini 机器人
|
| 31 |
- 配置了 ESPHome 集成的 Home Assistant
|
| 32 |
|
| 33 |
-
###
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 34 |
|
| 35 |
```bash
|
| 36 |
# 克隆仓库
|
|
|
|
| 30 |
- Reachy Mini 机器人
|
| 31 |
- 配置了 ESPHome 集成的 Home Assistant
|
| 32 |
|
| 33 |
+
### 快速安装（推荐）
|
| 34 |
+
|
| 35 |
+
```bash
|
| 36 |
+
# 克隆仓库
|
| 37 |
+
git clone https://github.com/yourusername/reachy_mini_ha_voice.git
|
| 38 |
+
cd reachy_mini_ha_voice
|
| 39 |
+
|
| 40 |
+
# 运行自动安装脚本
|
| 41 |
+
# Linux/Mac:
|
| 42 |
+
./install.sh
|
| 43 |
+
|
| 44 |
+
# Windows:
|
| 45 |
+
powershell -ExecutionPolicy Bypass -File install.ps1
|
| 46 |
+
```
|
| 47 |
+
|
| 48 |
+
自动安装脚本将自动完成：
|
| 49 |
+
- ✓ 检查 Python 版本
|
| 50 |
+
- ✓ 创建虚拟环境
|
| 51 |
+
- ✓ 安装所有依赖
|
| 52 |
+
- ✓ 下载唤醒词模型和声音效果
|
| 53 |
+
- ✓ 创建配置文件
|
| 54 |
+
- ✓ 检查 Reachy Mini SDK 安装
|
| 55 |
+
- ✓ 检查音频设备
|
| 56 |
+
|
| 57 |
+
### 手动安装
|
| 58 |
|
| 59 |
```bash
|
| 60 |
# 克隆仓库
|