docs: split INSTALL into English and Chinese, remove unsupported full-package option

- Rename existing INSTALL to INSTALL-cn.md with language toggle
- Rewrite INSTALL.md in English
- Remove "Option 2: Full Package" section (not yet supported)
- Replace outdated env-var LLM config with in-app Settings instructions
- Update storage estimate to ~2GB and simplify section titles
This commit is contained in:
groovyquan committed 2026-04-19 22:33:26 +08:00
1 parent 2e7623675b
commit 6c2443bb73
2 files changed
+14 -54

No files matched your search

+8 -27
View File
@@ -1,10 +1,12 @@
[English](INSTALL.md) | **简体中文**
# HiKid 安装指南
## 系统要求
- **macOS** 12.0+ (Apple Silicon / ARM64)
- **RAM**: 8GB+ (推荐 16GB)
- **存储**: 最小包 ~200MB,全量包 ~2GB
- **存储**: ~2GB(含模型文件)
## 首次运行(重要)
@@ -31,9 +33,7 @@ xattr -cr /Applications/HiKid.app
---
## 方案一:最小安装包(推荐开发者)
应用体积最小,但需要手动安装依赖。
## 安装步骤
### 1. 安装 SoX(音频工具)
@@ -80,34 +80,15 @@ rm kitten-tts-models.tar.gz
---
## 方案二:全量安装包(推荐普通用户)
开箱即用,无需手动下载任何依赖。
### 步骤
1. 下载 `HiKid-x.x.x.dmg`
2. 打开 DMG,将 `HiKid.app` 拖入 Applications 文件夹
3. 首次启动时前往 **系统设置 > 隐私与安全性 > 麦克风**,允许 HiKid 访问麦克风
4. 双击启动,开始和 Kitten 对话!
---
## 启动 LLM 后端
HiKid 默认连接本地的 Ollama 服务:
```bash
ollama run qwen3
ollama run qwen3:0.6b
```
如果使用其他 LLM 后端,设置环境变量:
```bash
export OPENAI_BASE_URL="http://localhost:11434/v1"
export OPENAI_API_KEY="ollama"
export MODEL_NAME="qwen3"
```
如需使用其他 LLM 后端,打开应用内的**设置**面板,直接在里面配置 AI 地址、API 密钥和模型名称即可,无需修改环境变量。
---
@@ -123,11 +104,11 @@ brew install sox
### "kitten-tts-server not found"
TTS 服务器二进制文件缺失。按方案一第 2 步安装。
TTS 服务器二进制文件缺失。按上面第 2 步安装。
### "ASR model not found"
模型文件缺失。按方案一第 3 步下载模型,或启动应用后使用内置下载功能。
模型文件缺失。按上面第 3 步下载模型,或启动应用后使用内置下载功能。
### 麦克风无响应
+6 -27
View File
@@ -6,7 +6,7 @@
- **macOS** 12.0+ (Apple Silicon / ARM64)
- **RAM**: 8GB+ (16GB recommended)
- **Storage**: Minimal package ~200MB, full package ~2GB
- **Storage**: ~2GB (including model files)
## First Launch (Important)
@@ -33,9 +33,7 @@ Hold the `Control` key and click the app icon, then choose "Open"
---
## Option 1: Minimal Package (Recommended for Developers)
Smallest app size, but requires manual dependency installation.
## Installation Steps
### 1. Install SoX (audio tools)
@@ -82,34 +80,15 @@ Drag `HiKid.app` into your Applications folder and launch.
---
## Option 2: Full Package (Recommended for Regular Users)
Works out of the box, no manual downloads needed.
### Steps
1. Download `HiKid-x.x.x.dmg`
2. Open the DMG and drag `HiKid.app` into Applications
3. On first launch, go to **System Settings > Privacy & Security > Microphone** and allow HiKid microphone access
4. Double-click to launch and start talking to Kitten!
---
## Start the LLM Backend
HiKid connects to a local Ollama service by default:
```bash
ollama run qwen3
ollama run qwen3:0.6b
```
If using a different LLM backend, set environment variables:
```bash
export OPENAI_BASE_URL="http://localhost:11434/v1"
export OPENAI_API_KEY="ollama"
export MODEL_NAME="qwen3"
```
To use a different LLM backend, open **Settings** in the app and configure the AI endpoint, API key, and model name there — no environment variables needed.
---
@@ -125,11 +104,11 @@ brew install sox
### "kitten-tts-server not found"
The TTS server binary is missing. Install it following Option 1 Step 2.
The TTS server binary is missing. Install it following Step 2 above.
### "ASR model not found"
Model files are missing. Download them following Option 1 Step 3, or use the built-in download feature after launching the app.
Model files are missing. Download them following Step 3 above, or use the built-in download feature after launching the app.
### Microphone not responding