Farama-Foundation / Minigrid

Simple and easily configurable grid world environments for reinforcement learning

https://minigrid.farama.org/

Other

2.09k stars 604 forks source link

Update README #272

Closed rodrigodelazcano closed 1 year ago

rodrigodelazcano commented 1 year ago

Description

Add README draft in Farama project style

Installation
Included environments
Citations

Fixes # (issue)

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] This change requires a documentation update

Screenshots

Please attach before and after screenshots of the change if applicable.

Checklist:

[x] I have run the pre-commit checks with pre-commit run --all-files (see CONTRIBUTING.md instructions to set it up)
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[ ] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes