Browse Source

Update homepage website (#276)

Rodrigo de Lazcano 2 years ago
parent
commit
4536ca6cf0
1 changed files with 7 additions and 3 deletions
  1. 7 3
      docs/index.md

+ 7 - 3
docs/index.md

@@ -3,10 +3,14 @@ hide-toc: true
 firstpage:
 lastpage:
 ---
-## Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research.
+## Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research. This library was previously known as gym-minigrid.
 
-[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+```{figure} ../figures/door-key-curriculum.gif
+   :alt: door_key_gif
+   :width: 500
+   :height: 500
+```
 
 This library contains a collection of 2D grid-world environments with goal-oriented tasks. The agent in these environments is a triangle-like agent with a discrete action space. The tasks involve solving different maze maps and interacting with different objects such as doors, keys, or boxes.  The design of the library is meant to be simple, fast, and easily customizable.