Skip to content

Commit

Permalink
updated documentation with installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
BolunDai0216 committed Sep 25, 2023
1 parent f7fc5d0 commit 8912a1e
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/content/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Installation

To install `miniworld`, the easiest way is to use `pip`:

```bash
pip install miniworld
```

However, if you would like to build on top of `miniworld`, you would need to install it from source. To do this, first clone the repository:

```bash
git clone https://github.com/Farama-Foundation/Miniworld.git
```

Then, install the package:

```bash
cd Miniworld
python3 -m pip install .
```

If you want to install the package in [development mode](https://setuptools.pypa.io/en/latest/userguide/development_mode.html), use the following command instead:

```bash
python3 -m pip install -e .
```

An installation in development mode (i.e., an editable install) is useful if you want to modify the source code of `miniworld` and have your changes take effect immediately.

0 comments on commit 8912a1e

Please sign in to comment.