Hugging Face's logo

Spaces:
djhui5710
/
reachy_mini_home_assistant
Running

App Files Community
14
Desmond-Dong commited on
Commit
7ffaa4a
·
1 Parent(s): b9b4225

docs: update README to highlight one-click web UI installation

Browse files

- Add Web UI option as the easiest installation method
- Users only need to click a button, no commands required
- Update both English and Chinese README files
- Make installation process completely user-friendly

Files changed (2) hide show
  1. README.md +21 -8
  2. README_CN.md +21 -8
README.md CHANGED
@@ -39,22 +39,21 @@ 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
- ### 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
@@ -63,6 +62,20 @@ The automated installation script will:
63
  - ✓ Check Reachy Mini SDK installation
64
  - ✓ Check audio devices
65
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
66
  ### Manual Installation
67
 
68
  ```bash
 
39
  - Reachy Mini robot
40
  - Home Assistant with ESPHome integration
41
 
42
+ ### One-Click Installation (Recommended - No Commands Required!)
43
 
44
+ **Option 1: Web UI (Easiest)**
45
  ```bash
46
  # Clone the repository
47
  git clone https://github.com/yourusername/reachy_mini_ha_voice.git
48
  cd reachy_mini_ha_voice
49
 
50
+ # Run the installation UI
51
+ python start.py
 
 
 
 
52
  ```
53
 
54
+ Then open your browser to `http://localhost:7860` and click the **"🚀 Start Installation"** button!
55
+
56
+ The installation will automatically:
57
  - ✓ Check Python version
58
  - ✓ Create virtual environment
59
  - ✓ Install all dependencies
 
62
  - ✓ Check Reachy Mini SDK installation
63
  - ✓ Check audio devices
64
 
65
+ **Option 2: Command Line**
66
+ ```bash
67
+ # Clone the repository
68
+ git clone https://github.com/yourusername/reachy_mini_ha_voice.git
69
+ cd reachy_mini_ha_voice
70
+
71
+ # Run the automated installation script
72
+ # For Linux/Mac:
73
+ ./install.sh
74
+
75
+ # For Windows:
76
+ powershell -ExecutionPolicy Bypass -File install.ps1
77
+ ```
78
+
79
  ### Manual Installation
80
 
81
  ```bash
README_CN.md CHANGED
@@ -30,22 +30,21 @@
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
  - ✓ 安装所有依赖
@@ -54,6 +53,20 @@ powershell -ExecutionPolicy Bypass -File install.ps1
54
  - ✓ 检查 Reachy Mini SDK 安装
55
  - ✓ 检查音频设备
56
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
57
  ### 手动安装
58
 
59
  ```bash
 
30
  - Reachy Mini 机器人
31
  - 配置了 ESPHome 集成的 Home Assistant
32
 
33
+ ### 一键安装（推荐 - 无需输入命令！）
34
 
35
+ **选项 1: Web 界面（最简单）**
36
  ```bash
37
  # 克隆仓库
38
  git clone https://github.com/yourusername/reachy_mini_ha_voice.git
39
  cd reachy_mini_ha_voice
40
 
41
+ # 运行安装界面
42
+ python start.py
 
 
 
 
43
  ```
44
 
45
+ 然后在浏览器中打开 `http://localhost:7860`，点击 **"🚀 Start Installation"** 按钮即可！
46
+
47
+ 安装将自动完成：
48
  - ✓ 检查 Python 版本
49
  - ✓ 创建虚拟环境
50
  - ✓ 安装所有依赖
 
53
  - ✓ 检查 Reachy Mini SDK 安装
54
  - ✓ 检查音频设备
55
 
56
+ **选项 2: 命令行**
57
+ ```bash
58
+ # 克隆仓库
59
+ git clone https://github.com/yourusername/reachy_mini_ha_voice.git
60
+ cd reachy_mini_ha_voice
61
+
62
+ # 运行自动安装脚本
63
+ # Linux/Mac:
64
+ ./install.sh
65
+
66
+ # Windows:
67
+ powershell -ExecutionPolicy Bypass -File install.ps1
68
+ ```
69
+
70
  ### 手动安装
71
 
72
  ```bash