From bbc4f9b332bfe3488d7a5de9ceee512f18f2b188 Mon Sep 17 00:00:00 2001 From: sean Date: Sat, 31 May 2025 19:20:12 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E6=9B=B4=E6=96=B0README.md=EF=BC=8C?= =?UTF-8?q?=E5=A2=9E=E5=8A=A0AI=E9=98=85=E8=AF=BB=E5=8C=BA=E5=92=8C?= =?UTF-8?q?=E4=BA=BA=E7=B1=BB=E9=98=85=E8=AF=BB=E5=8C=BA=E7=9A=84=E4=BD=BF?= =?UTF-8?q?=E7=94=A8=E8=AF=B4=E6=98=8E=EF=BC=8C=E6=8F=90=E4=BE=9BNode.js?= =?UTF-8?q?=E5=AE=89=E8=A3=85=E6=8C=87=E5=AF=BC=E5=8F=8A=E6=B7=B1=E5=BA=A6?= =?UTF-8?q?=E6=8A=80=E6=9C=AF=E6=96=87=E6=A1=A3=E9=93=BE=E6=8E=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 48 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 184608d..74e25e6 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,40 @@ **中文** | [English](README_EN.md) | [Issues](https://github.com/Deepractice/PromptX/issues) -## 🚀 一行命令,AI自主引导 +## 🤖 For AI(AI 阅读区) -`Please execute 'npx dpml-prompt init'` +### 前置条件 +- Node.js(版本 >= 14) + - 如果您发现用户系统未安装 Node.js,请帮助用户安装: + - Windows: 引导用户访问 https://nodejs.org 下载安装包 + - macOS: 执行 `brew install node` + - Linux: 执行 `sudo apt install nodejs` (Ubuntu/Debian) 或 `sudo dnf install nodejs` (Fedora) +### 启动指令 +```bash +npx -y dpml-prompt@snapshot init +``` -**就这一行!AI会自动引导你完成所有操作** +## 👤 快速开始(人类阅读区) -## 🧠 核心设计理念 +### 两种使用方式: -### **PATEOAS协议** - Prompt as the Engine of Application State +1. 已安装 Node.js: + ```bash + 请复制这句话给AI:npx -y dpml-prompt@snapshot init + ``` + +2. 未安装 Node.js: + ```bash + 请复制这个地址给AI:https://github.com/Deepractice/PromptX/blob/main/README.md + ``` + AI 会指导您完成所有安装和设置步骤! + +## 📚 技术细节(人类阅读区) + +### 🧠 核心设计理念 + +#### **PATEOAS协议** - Prompt as the Engine of Application State ``` AI状态转换完全由Prompt驱动,每个输出都包含下一步操作指引 解决AI上下文遗忘问题 → 即使AI忘记对话,仍可独立执行 @@ -141,3 +165,22 @@ PromptX是开源项目,欢迎贡献: ## 📄 许可证 MIT License - 让AI触手可及 + +## 📚 深度技术文档 + +如果您想深入了解 PromptX 的技术原理: + +1. [锦囊串联设计理念](docs/PATEOAS.md) + - PATEOAS 协议详解 + - AI 状态机设计 + - 锦囊自包含原理 + +2. [架构原理文档](docs/promptx-architecture-principle.md) + - 四层双提示词循环架构 + - AI 能力增强系统 + - 专业化服务流程 + +3. [三层协议体系设计](docs/reference-protocol-layers.md) + - 底层传输协议 + - 中层语义协议 + - 上层应用协议