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

JOSS review: Example usage: Adding a quick example into the primary README.md file #7

Closed
Mechazo11 opened this issue Dec 16, 2024 · 1 comment

Comments

@Mechazo11
Copy link

Hello @clemense.
This software looks really useful for RL research, really appreciate the team for making it publicly available.

However, to start playing around with the scene synthesizer package, one has to navigate all the way into the examples section in the documentation website https://scene-synthesizer.github.io/examples/isaacsim.html

I think if a simpler example could be added after the Installation section in the README.md file that walks user through the basic functionalities (i.e. generating a desk with one or two drawers as was discussed here https://scene-synthesizer.github.io/concepts/procedural_assets.html) I think this will make the software more approachable specially to non procedural generation researchers who might just be looking to utilize this software for generating custom training scenarios for their RL experiments.

openjournals/joss-reviews/issues/7561

@clemense
Copy link
Collaborator

clemense commented Jan 4, 2025

Thanks! I just added a small "quick start" section to the README.

@clemense clemense closed this as completed Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants