[README] Fix typo in README #5
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves the README documentation by fixing a command syntax error and adding comprehensive troubleshooting instructions for code replication. The changes make it easier for users to set up the project environment and resolve common installation issues.
- Fixed spacing issue in the example command for running experiments
- Added new "Additional Notes on Code Replication" section with 6 setup/troubleshooting steps covering Python version, gym installation, pygame dependencies, box2d-py compilation, Mujoco setup, and mujoco-py compilation
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| ``` | ||
| sudo apt update && sudo apt install swig | ||
| ``` | ||
| 5. Download Mujoco package and add it to the `$PATH` in `~/.bashrc` |
There was a problem hiding this comment.
Inconsistent instruction format: Step 5 lacks the code block formatting used in other steps. Consider either adding a code block with the actual commands needed (e.g., for downloading and configuring PATH), or reformatting as plain text like the opening statement in step 1.
README.md
Outdated
| ``` | ||
| sudo apt update && sudo apt install swig | ||
| ``` | ||
| 5. Download Mujoco package and add it to the `$PATH` in `~/.bashrc` |
There was a problem hiding this comment.
Missing specific instructions: Step 5 mentions downloading Mujoco and adding it to PATH but doesn't provide concrete commands or download URLs. Consider adding the specific download location and example commands for adding to PATH (e.g., export PATH=$PATH:/path/to/mujoco/.mujoco/mujoco210/bin).
| 5. Download Mujoco package and add it to the `$PATH` in `~/.bashrc` | |
| 5. Download the Mujoco package from [https://mujoco.org/download](https://mujoco.org/download) (e.g., mujoco210), extract it to `~/.mujoco/mujoco210`, and add the Mujoco binary directory to your `$PATH` in `~/.bashrc`: |
export PATH=$PATH:$HOME/.mujoco/mujoco210/bin
README.md
Outdated
| The code of QVPO is based on the implementation of [DIPO](https://github.com/BellmanTimeHut/DIPO). | ||
|
|
||
| ## Additional Notes on Code Replication | ||
| 1. Better set python version to 3.10 |
There was a problem hiding this comment.
[nitpick] Inconsistent formatting: Step 1 states "Better set python version to 3.10" without a code block, while steps 2-4 and 6 include code blocks with commands. For consistency, either add all setup steps in code blocks or format them all as plain text instructions. If step 1 requires using a tool like pyenv or conda to set the Python version, include that command in a code block.
| 1. Better set python version to 3.10 | |
| 1. Set Python version to 3.10: |
conda install python=3.10
Signed-off-by: Bichy <bichyzhang@gmail.com>
c0b814a to
24f4894
Compare
No description provided.