Review Documentation Readme.md

[simoninithomas]

Hey there 👋 , so here the review of readme.md:

Feedback

• Made the test on a Windows 10 computer with conda

1️⃣ => Don’t forget to change it if the namespace change.

2️⃣ ⇒ Once the scene is created, you can save and share it as a file. This is a gIFT file, aka a JSON file with associated resources.

You can also render the scene or do simulations using one of the backend rendering/simulation engines (at the moment Unity, Blender and Godot).

I would also add more details on the saving/sharing format is engine agnostic and using a graphic industry standard (I suppose you talk about gIFT)

3️⃣ Wrong placement since it’s for contributing.

4️⃣ ModuleNotFoundError: No module named 'mypy_extensions’ when we install simulate. ⇒ Can we add it to the requirement list?

5️⃣ I think something is missing there 🤔

6️⃣ Loading a scene from a local file or the hu is done with ⇒ The hu?

7️⃣ Ok some problems in the code:

1. I think the path is not correct for the first line
2. Second push_to_hub: don’t hesitate to add a comment saying that they need to change the path. In RL class a lot of people say "I don't have permission to push to ThomasSimonini/LunarLander" so it's important to be clear 😄. ⇒ I would add scene.show() at the end of the code so that they can visualize by themselves the red cube.

The content after is good. The node system is well explained.

[osanseviero]

Very nice feedback :fire: Feel free to open PRs directly to fix some of these that have a clear fix :)

• The requirements
• The hu? -> The Hub
• Code, etc

[simoninithomas]

Good idea, thanks I created a PR for 2-3-4-6 here: #279