Skip to content

Commit

Permalink
revise readme
Browse files Browse the repository at this point in the history
  • Loading branch information
binary-husky committed Sep 12, 2024
1 parent 10e060f commit d04a689
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
9 changes: 5 additions & 4 deletions docs/installation_zh.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MemoryScope 安装指南

## 一、使用 Docker 安装 [推荐]
## 一、使用 Docker 安装 [推荐] [x86_64]

1. 克隆仓库并编辑配置
```bash
Expand All @@ -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
Expand All @@ -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 安装
Expand Down

0 comments on commit d04a689

Please sign in to comment.