Skip to content

Commit c969a7f

Browse files
committed
docs: 更新 README.md,添加功能特色、安装与运行说明及依赖服务信息
1 parent d508e20 commit c969a7f

1 file changed

Lines changed: 60 additions & 1 deletion

File tree

README.md

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,61 @@
11
# PVenus
2-
A virtual AI girlfriend powered by multi-modal intelligence, designed to be your emotional companion, voice assistant, and digital soulmate. | AI虚拟女友,感性与智能并存的陪伴系统。
2+
A virtual AI girlfriend powered by multi-modal intelligence, designed to be your emotional companion, voice assistant, and digital soulmate. | AI虚拟女友,感性与智能并存的陪伴系统。
3+
4+
## 功能特色
5+
6+
- 💬 支持自然语言对话,智能理解与个性化回复
7+
- 🖼️ 支持图片分析,自动识别图片内容并生成描述
8+
- 🗣️ 语音合成与多音色选择,AI 可用多种声音与语速朗读回复
9+
- 🧠 永久记忆系统,AI 可记住重要信息并随时调用
10+
- 📝 聊天历史保存,支持上下文连续对话
11+
- 🖥️ 提供 CLI(命令行)与 GUI(图形界面)两种交互方式
12+
13+
## 安装与运行
14+
15+
### 依赖环境
16+
17+
- Python 3.8+
18+
- 推荐使用 [conda](https://docs.conda.io/) 或 venv 虚拟环境
19+
20+
### 安装依赖
21+
22+
```sh
23+
pip install -r requirements.txt
24+
```
25+
26+
### 启动 GUI 版
27+
28+
```sh
29+
python GUI/mainGUI.py
30+
```
31+
32+
### 启动 CLI 版
33+
34+
```sh
35+
python CLI/mainCLI.py
36+
```
37+
38+
## 配置说明
39+
40+
首次运行时会提示输入以下信息:
41+
42+
- SiliconFlow Key(用于多模态与语音服务)
43+
- OpenAI Key(用于 GPT-4o 智能对话)
44+
- OpenAI API 网关(可选,默认官方)
45+
46+
用户偏好(职业、称呼、回复风格等)也可在设置界面或 CLI 交互中自定义。
47+
48+
配置、记忆与聊天记录均保存在 `data/` 目录下(GUI)或当前目录(CLI)。
49+
50+
## 依赖第三方服务
51+
52+
- [SiliconFlow](https://www.siliconflow.cn/) 多模态与语音 API
53+
- [OpenAI](https://platform.openai.com/) GPT-4o 智能对话
54+
55+
## 开源协议
56+
57+
本项目采用 MIT License,详见 [LICENSE](LICENSE)
58+
59+
---
60+
61+
如有建议或问题,欢迎提交 issue 或 PR!

0 commit comments

Comments
 (0)