Files
TrulyMEM-TrueHumanMEM/README_EN.md
root 4770b3b990 refactor: Web 服务内嵌主进程 + 文档移到 docs/ 二级目录
1. Web 服务改为 threading 模式:
   - 新增 run_web_server(port) / stop_web_server() 函数
   - TUI 通过 from web_api import run_web_server 直接调用
   - 使用 werkzeug make_server 实现线程内优雅启动/停止
2. 构建脚本精简为单二进制:
   - 移除 trulymem-web 独立打包步骤
   - 添加 werkzeug 到 hidden-imports
3. 详细启动文档移到 docs/zh/quick_start.md
4. README 精简为概述,指向 docs/ 目录
2026-04-28 10:50:24 +08:00

65 lines
2.0 KiB
Markdown

# TrulyMEM - TrueHumanMEM
<p align="center">
<img src="pic/image.png" alt="TrulyMEM Logo" width="200">
</p>
> **📜 License**: [GNU General Public License v3.0 (GPLv3)](https://www.gnu.org/licenses/gpl-3.0)
> **中文**: [README.md](./README.md)
**Give AI self-awareness, plasticity, and a sense of proportion in long-term memory** — *The More Human Choice.*
[![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/)
---
## In a Nutshell
TrulyMEM gives memory authority back to the LLM. Using graph database (triplets) instead of the traditional messages array, the LLM autonomously decides what to remember and what to forget.
---
## Quick Start
```bash
python trulymem_entry.py # from source
./dist/TrulyMEM # packaged binary
```
First run → TUI login screen → create/sign in → press **F2** for API Key → start chatting
📖 **Full guide**: [docs/en/quick_start.md](docs/en/quick_start.md)
---
## Features
| Feature | Description |
|---------|-------------|
| 🧠 **Graph Memory** | Triplet storage, LLM autonomous navigation |
| 🔐 **Multi-User** | Isolated profiles + Admin/User roles |
| 🌐 **Web UI** | Embedded Flask server (thread mode) for knowledge graph browsing |
| 🎮 **TUI** | Textual-based terminal UI with F2 config panel |
| 📦 **Single Binary** | PyInstaller build, Web server embedded |
---
## Documentation
| Document | Content |
|----------|---------|
| [docs/en/quick_start.md](docs/en/quick_start.md) | 🔥 **Full setup guide** (Web, multi-user, building) |
| [docs/en/architecture.md](docs/en/architecture.md) | System architecture and design |
| [docs/en/memory.md](docs/en/memory.md) | Memory working mechanism |
| [docs/en/persona.md](docs/en/persona.md) | Persona Graph mechanism |
| [docs/en/api.md](docs/en/api.md) | Backend API |
| [docs/en/prompts.md](docs/en/prompts.md) | Prompt management |
---
## License
GNU General Public License v3.0 (GPLv3)