Docs: sync README with actual repository, remove footer

This commit is contained in:
root
2026-04-12 16:04:14 +08:00
parent b4f509de50
commit 7fe56e8319

123
README.md
View File

@ -6,24 +6,23 @@
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/) [![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)](https://github.com/yourusername/trulymem) [![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey.svg)]()
--- ---
## 简介 ## 简介
TrulyMEMTrueHumanMEM是一个让 AI 拥有长期记忆能力的图记忆系统。通过图数据库存储实体关系让AI能够像人类一样记忆、回忆和管理信息。 TrulyMEM (TrueHumanMEM) 是一个让 AI 拥有长期记忆能力的图记忆系统。通过 SQLite 内嵌图数据库存储实体关系,让 AI 能够像人类一样记忆、回忆和管理信息。
### 核心特性 ### 核心特性
- 🧠 **长期记忆** - 基于图数据库的持久化记忆存储 - 🧠 **长期记忆** - 基于 SQLite 图数据库的持久化存储,开箱即用
- 🎭 **人设图机制** - AI角色保持和角色扮演支持 - 🎭 **人设图机制** - AI 角色保持和角色扮演支持
- 🖥️ **现代化TUI** - 基于Textual框架的终端用户界面 - 🔗 **工作记忆链** - 维持对话连贯性的任务跟踪机制
- 💾 **内嵌数据库** - SQLite实现无需Docker/Neo4j - 🖥️ **现代化 TUI** - 基于 Textual 框架的终端用户界面,键盘驱动
- 🌐 **Web接口** - 支持浏览器访问 - 💾 **内嵌数据库** - SQLite 实现,无需 Docker/Neo4j
- 🚀 **流式显示** - 实时显示AI响应减少等待
- 📦 **独立部署** - 支持打包为独立可执行文件 - 📦 **独立部署** - 支持打包为独立可执行文件
- 🌍 **跨平台** - 支持Windows/Linux/macOS - 🌍 **跨平台** - 支持 Windows/Linux/macOS
--- ---
@ -34,13 +33,11 @@ TrulyMEMTrueHumanMEM是一个让 AI 拥有长期记忆能力的图记忆
**Windows:** **Windows:**
```bash ```bash
# 下载 TrulyMEM.exe # 下载 TrulyMEM.exe
# 双击运行或命令行执行
./TrulyMEM.exe ./TrulyMEM.exe
``` ```
**Linux:** **Linux:**
```bash ```bash
# 下载 TrulyMEM
chmod +x TrulyMEM chmod +x TrulyMEM
./TrulyMEM ./TrulyMEM
``` ```
@ -49,20 +46,20 @@ chmod +x TrulyMEM
```bash ```bash
# 克隆仓库 # 克隆仓库
git clone https://github.com/yourusername/trulymem.git git clone <repo-url>
cd trulymem cd TrulyMEM-TrueHumanMEM
# 安装依赖 # 安装依赖
pip install -r requirements.txt pip install -r requirements.txt
# 运行应用 # 运行应用
python -m graph_memory_tui.main python trulymem_entry.py
``` ```
### 配置 ### 配置
1.**F2** 展开侧边栏 1.**F2** 展开侧边栏
2. 输入 **API Key**支持DeepSeek、OpenAI 2. 输入 **API Key**(支持 DeepSeek、OpenAI 等兼容 API
3.**Enter** 保存配置 3.**Enter** 保存配置
4. 开始对话! 4. 开始对话!
@ -81,15 +78,21 @@ python -m graph_memory_tui.main
| `memory_archive` | 归档记忆 | 归档旧记忆 | | `memory_archive` | 归档记忆 | 归档旧记忆 |
| `memory_cleanup` | 清理数据 | 清理无效数据 | | `memory_cleanup` | 清理数据 | 清理无效数据 |
### 人设图机制 ### 人设工具
AI会在每轮对话前查询人设图严格按照人设回复确保角色一致性。 | 工具 | 功能 | 说明 |
|------|------|------|
| `persona_update` | 更新人设 | 修改 AI 的角色、性格、语气 |
| `persona_clear` | 清除人设 | 恢复默认身份 |
**使用示例:** ### 任务工具(工作记忆链)
```
用户:以猫娘的语气跟我说话 | 工具 | 功能 | 说明 |
AI喵~好的主人!我会用可爱的猫娘语气跟你说话的喵!(≧ω≦) |------|------|------|
``` | `task_create` | 创建任务 | 跟踪连续性任务 |
| `task_set_state` | 设置状态 | 更新任务状态 |
| `task_delete` | 删除任务 | 清理完成任务 |
| `task_link_info` | 关联信息 | 连接任务与记忆 |
### 快捷键 ### 快捷键
@ -98,7 +101,7 @@ AI喵~好的主人!我会用可爱的猫娘语气跟你说话的喵!(≧
| F1 | 帮助 | | F1 | 帮助 |
| F2 | 切换侧边栏 | | F2 | 切换侧边栏 |
| F3 | 工具详情 | | F3 | 工具详情 |
| F4 | 查询框 | | F4 | 聚焦查询框 |
| F5 | 清屏 | | F5 | 清屏 |
| F6 | 退出 | | F6 | 退出 |
@ -107,19 +110,26 @@ AI喵~好的主人!我会用可爱的猫娘语气跟你说话的喵!(≧
## 项目结构 ## 项目结构
``` ```
trulymem/ TrulyMEM-TrueHumanMEM/
├── graph_memory_tui/ # TUI应用 ├── trulymem_entry.py # 打包入口
│ ├── core/ # 核心逻辑 ├── graph_memory_tui/ # 核心应用
│ ├── handlers/ # 事件处理 │ ├── app.py # TUI 主应用
│ ├── models/ # 数据模型 │ ├── main.py # 模块入口
│ ├── services/ # 服务层 │ ├── core/ # 核心逻辑
│ ├── widgets/ # UI组件 │ ├── embedded_db.py # SQLite 图数据库
└── styles/ # 样式文件 │ ├── graph_client.py # Neo4j 客户端(可选)
├── docs/ # 文档 ├── imports.py # 动态导入
├── tests/ # 测试 │ │ ├── prompts/ # 提示词管理
├── requirements.txt # 依赖清单 │ │ └── tools/ # 工具定义
├── LICENSE # 许可证 │ ├── models/ # 数据模型
└── README.md # 说明文档 │ ├── services/ # 服务层
│ ├── handlers/ # 事件处理
│ ├── widgets/ # TUI 组件
│ └── styles/ # 样式文件
├── tests/ # 测试
├── docs/ # 文档
├── requirements.txt # 依赖清单
└── LICENSE # 许可证
``` ```
--- ---
@ -127,10 +137,9 @@ trulymem/
## 技术栈 ## 技术栈
- **Python 3.8+** - 编程语言 - **Python 3.8+** - 编程语言
- **Textual** - TUI框架 - **Textual** - TUI 框架
- **SQLite** - 内嵌数据库 - **SQLite** - 内嵌数据库
- **Flask** - Web框架 - **OpenAI SDK** - API 调用(兼容 DeepSeek
- **OpenAI SDK** - API调用
--- ---
@ -172,12 +181,12 @@ bash build_linux.sh
详见 [LICENSE](LICENSE) 文件。 详见 [LICENSE](LICENSE) 文件。
### 许可证要点 ### 许可证要点
- 可以自由使用、修改和分发 - 可以自由使用、修改和分发
- 必须保留版权声明和许可证 - 必须保留版权声明和许可证
- 修改后的作品必须以相同许可证发布 - 修改后的作品必须以相同许可证发布
- 必须提供源代码 - 必须提供源代码
--- ---
@ -185,8 +194,6 @@ bash build_linux.sh
欢迎提交 Issue 和 Pull Request 欢迎提交 Issue 和 Pull Request
### 贡献指南
1. Fork 本仓库 1. Fork 本仓库
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`) 2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`) 3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
@ -195,22 +202,10 @@ bash build_linux.sh
--- ---
## 作者 ## 文档
**jianf** - 项目设计与开发 更多文档见 [docs/](docs/) 目录:
--- - [架构设计](docs/架构.md) - 系统架构和技术设计
- [快速开始](docs/一键启动指南.md) - 启动指南
## 致谢 - [工作记忆链机制说明](docs/工作记忆链机制说明.md) - 连续性任务处理
感谢所有为这个项目做出贡献的开发者和用户。
---
<div align="center">
**TrulyMEM —— 让 AI 的记忆方式,更像人。**
*Made with ❤️ by jianf*
</div>