Update readme#2470
Merged
openminddev merged 10 commits intomainfrom Mar 13, 2026
Merged
Conversation
github-actions
Bot
added
the
documentation
…update-readme merge main
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the project README to improve onboarding and documentation navigation, and to introduce simulator support for OM1.
Changes:
- Expands the OM1 product description to include simulator targets (Gazebo / Isaac Sim).
- Restructures “Getting Started” with explicit system dependency installation and an expanded API key / billing section.
- Fixes the “examples” docs link and adds a dedicated “Simulator Support” section with local doc links.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
Overview
This PR updates readme to fix broken links, restructure getting started steps and also include simulation introduction.