Merge pull request #109 from BolunDai0216/master

Updated Documentation Website with Installation Guide

README.md

@@ -44,19 +44,6 @@ Limitations:
 - Graphics are basic, nowhere near photorealism
 - Physics are very basic, not sufficient for robot arms or manipulation
 
-Please use this bibtex if you want to cite this repository in your publications:
-
-```
-@misc{gym_miniworld,
-  author = {Chevalier-Boisvert, Maxime},
-  title = {MiniWorld: Minimalistic 3D Environment for RL & Robotics Research},
-  year = {2018},
-  publisher = {GitHub},
-  journal = {GitHub repository},
-  howpublished = {\url{https://github.com/maximecb/gym-miniworld}},
-}
-```
-
 List of publications & submissions using MiniWorld (please open a pull request to add missing entries):
 - [Decoupling Exploration and Exploitation for Meta-Reinforcement Learning without Sacrifices](https://arxiv.org/abs/2008.02790) (Stanford University, ICML 2021)
 - [Rank the Episodes: A Simple Approach for Exploration in Procedurally-Generated Environments](https://openreview.net/forum?id=MtEE0CktZht) (Texas A&M University, Kuai Inc., ICLR 2021)

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.