From d04a689fdc225b8ee957a69bcb0e2ac1e7e7de4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=9D=92=E8=BD=A9?= Date: Thu, 12 Sep 2024 17:30:28 +0800 Subject: [PATCH] revise readme --- docs/installation.md | 8 ++++---- docs/installation_zh.md | 9 +++++---- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/installation.md b/docs/installation.md index b4453172..fcaa589d 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,6 +1,6 @@ # Installing MemoryScope -## I. Install with docker [Recommended] +## I. Install with docker [Recommended] [x86_64] 1. Clone the repository and edit settings ```bash @@ -16,13 +16,13 @@ sudo docker build --network=host -t memoryscope . ``` -3. Launch Docker container +3. Launch Docker container (ARM architecture not yet supported) ```bash sudo docker run -it --rm --net=host memoryscope ``` -## II. Install with docker compose [Recommended] +## II. Install with docker compose [Recommended] [x86_64] 1. Clone the repository and edit settings ```bash @@ -38,7 +38,7 @@ OPENAI_API_KEY: "sk-0000000000" ``` -3. Run `docker-compose run memory_scope_main` to build and launch the memory-scope cli interface. +3. Run `docker-compose run memory_scope_main` to build and launch the memory-scope cli interface. (ARM architecture not yet supported) ## III. Install from PyPI diff --git a/docs/installation_zh.md b/docs/installation_zh.md index 0803299b..388ddf91 100644 --- a/docs/installation_zh.md +++ b/docs/installation_zh.md @@ -1,6 +1,6 @@ # MemoryScope 安装指南 -## 一、使用 Docker 安装 [推荐] +## 一、使用 Docker 安装 [推荐] [x86_64] 1. 克隆仓库并编辑配置 ```bash @@ -16,13 +16,14 @@ sudo docker build --network=host -t memoryscope . ``` -3. 启动 Docker 容器 +3. 启动 Docker 容器 (备注：ARM架构暂不支持) ```bash sudo docker run -it --rm --net=host memoryscope ``` -## 二、使用 Docker Compose 安装 [推荐] + +## 二、使用 Docker Compose 安装 [推荐] [x86_64] 1. 克隆仓库并编辑配置 ```bash @@ -38,7 +39,7 @@ DASHSCOPE_API_KEY: "sk-0000000000" ``` -3. 运行 `docker-compose run memory_scope_main` 命令来构建并启动 MemoryScope CLI 界面。 +3. 运行 `docker-compose run memory_scope_main` 命令来构建并启动 MemoryScope CLI 界面。 (备注：ARM架构暂不支持) ## 三、通过 PYPI 安装