From 3d684834bdffdda3b0d1e27089a1e7f3a7ac99ab Mon Sep 17 00:00:00 2001 From: Kashu7100 Date: Wed, 25 Dec 2024 04:53:25 -0500 Subject: [PATCH] update readme --- README.md | 8 ++++---- README_CN.md | 20 ++++++++++++++++++++ 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7ea3a5ae..3fd756d3 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/README_CN.md b/README_CN.md index 41e8c424..ef84b230 100644 --- a/README_CN.md +++ b/README_CN.md @@ -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 参考。