docs: comprehensive README overhaul — add pre-alpha status, badges, quick start, and community best practices#461
Closed
hajan wants to merge 1 commit intoisaac-sim:mainfrom
Closed
docs: comprehensive README overhaul — add pre-alpha status, badges, quick start, and community best practices#461hajan wants to merge 1 commit intoisaac-sim:mainfrom
hajan wants to merge 1 commit intoisaac-sim:mainfrom
Conversation
Signed-off-by: hajan <spencer.m.huang@gmail.com>
cvolkcvolk
reviewed
Mar 4, 2026
xyao-nv
reviewed
Mar 4, 2026
xyao-nv
reviewed
Mar 4, 2026
cvolkcvolk
approved these changes
Mar 5, 2026
Collaborator
cvolkcvolk
left a comment
cvolkcvolk
left a comment
There was a problem hiding this comment.
This looks great! Thanks for adding.
Open
Collaborator
|
@hajan I granted you Maintainer status. You might need to push your (forked) |
cvolkcvolk
added a commit
that referenced
this pull request
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 --------- Signed-off-by: Clemens Volk <cvolk@nvidia.com> Co-authored-by: hajan <spencer.m.huang@gmail.com>
Collaborator
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR replaces the current sparse README with a comprehensive version that follows GitHub community best practices and aligns with the style of the parent Isaac Lab repository.
What Changed
Added:
[!WARNING]callout making clear this is pre-alpha — not EA or GAPreserved:
Motivation
The current README is ~15 lines and gives newcomers very little context about what the project does, how to get started, or what maturity level to expect. For a pre-alpha community release explicitly seeking feedback, a thorough README is essential for onboarding contributors and setting correct expectations.