Skip to content

docs: comprehensive README overhaul#480

Merged
cvolkcvolk merged 8 commits intomainfrom
cvolk/improve-readme
Mar 13, 2026
Merged

docs: comprehensive README overhaul#480
cvolkcvolk merged 8 commits intomainfrom
cvolk/improve-readme

Conversation

@cvolkcvolk
Copy link
Collaborator

@cvolkcvolk cvolkcvolk commented Mar 13, 2026

Picks up the work from #461 (hajan:improve-readme), which couldn't pass CI due to a missing NVCR token on the fork.

Changes

  • Add pre-alpha status warning banner
  • Add version/platform/license badges
  • Add quick-start installation section
  • Add composability overview table (Scene / Embodiment / Task)
  • Add usage example (kitchen pick-and-place)
  • Add project structure tree (including missing isaaclab_arena_environments/ and isaaclab_arena_examples/)
  • Add version compatibility table (with corrected Isaac Sim 5.0.0 for release/0.1.1)
  • Add ecosystem, contributing, support, and citation sections
  • Restore "Made with ❤️ by the NVIDIA Robotics Team" footer

Add pre-alpha status banner, badges, quick-start guide, composability
overview, usage example, project structure, version compatibility
table, ecosystem section, and community best practices.

Address review feedback: add missing isaaclab_arena_environments/ and
isaaclab_arena_examples/ to project structure, fix Isaac Sim version
for release/0.1.1 (5.0.0 not 5.1.0), restore Made with love line.

Co-authored-by: hajan <spencer.m.huang@gmail.com>
Signed-off-by: Clemens Volk <cvolk@nvidia.com>
Use /isaac-sim/python.sh -m pytest, consistent with AGENTS.md and CI.

Signed-off-by: Clemens Volk <cvolk@nvidia.com>
The previous example imported from isaaclab_arena top-level, which
exports nothing. Replace with a minimal working example based on
isaaclab_arena/examples/compile_env_notebook.py using real module
paths.

Signed-off-by: Clemens Volk <cvolk@nvidia.com>
main pins IsaacLab at v2.3.2, not 2.3.0.

Signed-off-by: Clemens Volk <cvolk@nvidia.com>
Signed-off-by: Clemens Volk <cvolk@nvidia.com>
Signed-off-by: Clemens Volk <cvolk@nvidia.com>
Signed-off-by: Clemens Volk <cvolk@nvidia.com>
@cvolkcvolk cvolkcvolk merged commit 04a157f into main Mar 13, 2026
7 of 10 checks passed
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

Successfully merging this pull request may close these issues.

2 participants