slhaf/Partner
1
0
Fork 0
mirror of https://github.com/slhaf/Partner.git synced 2026-05-12 16:53:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
slhafzjw
2026-04-27 15:07:55 +08:00
parent e022f134ac
commit d43476864c
1 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -9,20 +9,19 @@ Agent 运行内核。
![Partner 架构总览](doc/assets/partner-overview.png) ![Partner 架构总览](doc/assets/partner-overview.png)
> 详细文档查看: [相关文档](#相关文档)
--- ---
## 项目启动 ## 项目启动
### 环境要求 **环境要求**
- JDK 21 - JDK 21
- Maven 3.x - Maven 3.x
### 启动项目 ### 手动准备环境并启动
#### 手动准备环境并启动 #### 克隆项目并构建
##### 克隆项目并构建
```bash ```bash
git clone https://github.com/slhaf/Partner git clone https://github.com/slhaf/Partner
@@ -39,7 +38,7 @@ mvn clean package -DskipTests
Partner-Core/target/Partner-Core-0.5.0.jar Partner-Core/target/Partner-Core-0.5.0.jar
``` ```
##### 准备必需配置 #### 准备必需配置
Partner 默认从 `~/.partner` 读取运行时配置，也可以通过 `PARTNER_HOME` 指定其他目录： Partner 默认从 `~/.partner` 读取运行时配置，也可以通过 `PARTNER_HOME` 指定其他目录：
@@ -93,9 +92,9 @@ export PARTNER_DEFAULT_MODEL="your-model-name"
} }
``` ```
> 其余详细配置信息参考 ![配置说明](doc/config/configuration.md) > 其余详细配置信息参考 [相关文档#配置说明](doc/config/configuration.md)
##### 启动项目 #### 启动
``` ```
java -jar Partner-Core/target/Partner-Core-0.5.0.jar java -jar Partner-Core/target/Partner-Core-0.5.0.jar
@@ -140,12 +139,12 @@ Partner/
### 待完成 ### 待完成
- ![整体架构与运行流](doc/architecture/overview.md) - [整体架构与运行流](doc/architecture/overview.md)
- ![ContextWorkspace](doc/context/context-workspace.md) - [ContextWorkspace](doc/context/context-workspace.md)
- ![行动系统](doc/action/action.md) - [行动系统](doc/action/action.md)
- ![记忆存储与组织](doc/memory/memory.md) - [记忆存储与组织](doc/memory/memory.md)
- ![模型提供商](doc/model/providers.md) - [模型提供商](doc/model/providers.md)
- ![配置说明](doc/config/configuration.md) - [配置说明](doc/config/configuration.md)
--- ---