Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Add Readme for setting up a new environment #299

Merged
merged 5 commits into from
Aug 20, 2021

Conversation

DriesSmit
Copy link
Contributor

What?

Add a Readme to guide users on how to take a new environment and make it compatible with Mava.

Why?

.

How?

Add a Readme to the wrappers folder inside Mava.

Extra

@DriesSmit DriesSmit added the enhancement New feature or request label Aug 17, 2021
@DriesSmit DriesSmit self-assigned this Aug 17, 2021
arnupretorius
arnupretorius previously approved these changes Aug 19, 2021
Copy link
Collaborator

@arnupretorius arnupretorius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @DriesSmit! 👍 I added some minor edits.

@arnupretorius
Copy link
Collaborator

Note: checks failing due to AutoRom, which will be fixed in this PR: #300

@KaleabTessera
Copy link
Contributor

KaleabTessera commented Aug 19, 2021

Looks great @DriesSmit !! Thanks for adding this.

Maybe add a pointer to this in the main readme here (https://github.com/instadeepai/Mava#supported-environments). Something like "For details on how to add your own environment, see (here)[link]".

KaleabTessera
KaleabTessera previously approved these changes Aug 19, 2021
@DriesSmit DriesSmit dismissed stale reviews from KaleabTessera and arnupretorius via 659f74e August 19, 2021 16:38
@DriesSmit
Copy link
Contributor Author

Looks great @DriesSmit !! Thanks for adding this.

Maybe add a pointer to this in the main readme here (https://github.com/instadeepai/Mava#supported-environments). Something like "For details on how to add your own environment, see (here)[link]".

Great idea @KaleabTessera 👍 I added a reference in the main text.

Copy link
Collaborator

@arnupretorius arnupretorius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @DriesSmit 👍

@arnupretorius arnupretorius merged commit 0f8b6b3 into develop Aug 20, 2021
@arnupretorius arnupretorius deleted the feature/add_env_readme branch August 20, 2021 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants