From 8912a1ecbc732716f732941d60143575c8432b18 Mon Sep 17 00:00:00 2001 From: Bolun Dai Date: Mon, 25 Sep 2023 09:26:54 -0400 Subject: [PATCH] updated documentation with installation guide --- docs/content/installation.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/content/installation.md diff --git a/docs/content/installation.md b/docs/content/installation.md new file mode 100644 index 00000000..3dd02d20 --- /dev/null +++ b/docs/content/installation.md @@ -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. \ No newline at end of file