Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Kashu7100 committed Dec 25, 2024
1 parent 4fc8eaf commit 3d68483
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,15 @@ cd Genesis
pip install -e .
```

## Docker Installation
## Docker Support

First build the Docker image:
If you want to use Genesis from Docker, you can first build the Docker image as:

```bash
docker build -t genesis -f docker/Dockerfile docker
```

And then run the examples inside the docker image (mounted to `/workspace/examples`):
Then you can run the examples inside the docker image (mounted to `/workspace/examples`):

```bash
xhost +local:root # Allow the container to access the display
Expand All @@ -89,7 +89,7 @@ docker run --gpus all --rm -it \
-e DISPLAY=$DISPLAY \
-v /tmp/.X11-unix/:/tmp/.X11-unix \
-v $PWD:/workspace \
genesis bash
genesis
```

## Documentation
Expand Down
20 changes: 20 additions & 0 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,26 @@ pip install genesis-world # 需要 Python >=3.9;

您还需要按照 [官方说明](https://pytorch.org/get-started/locally/) 安装 **PyTorch**

### Docker 支持

如果您想通过 Docker 使用 Genesis,您可以首先构建 Docker 镜像,命令如下:

```bash
docker build -t genesis -f docker/Dockerfile docker
```

然后,您可以在 Docker 镜像内运行示例代码(挂载到 `/workspace/examples`):

```bash
xhost +local:root # 允许容器访问显示器

docker run --gpus all --rm -it \
-e DISPLAY=$DISPLAY \
-v /tmp/.X11-unix/:/tmp/.X11-unix \
-v $PWD:/workspace \
genesis
```

### 文档

请参阅我们的 [文档网站(英文)](https://genesis-world.readthedocs.io/en/latest/user_guide/index.html)/[(中文)](https://genesis-world.readthedocs.io/zh-cn/latest/user_guide/index.html)以获取详细的安装步骤、教程和 API 参考。
Expand Down

0 comments on commit 3d68483

Please sign in to comment.