-
Notifications
You must be signed in to change notification settings - Fork 47
docs: update docs to reflect rai on pypi and interfaces on apt #612
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
Merged
Merged
Changes from all commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
4b68ada
docs: update rai core and whoami readmes
maciejmajek 7349173
docs: update setup docs
maciejmajek 88a009e
docs: update setup guide
maciejmajek 81bd39b
docs: cross link getting started to the main page
maciejmajek 1ce5254
docs: style change
maciejmajek 6d82a93
docs: style change
maciejmajek 4667ed0
docs: add release info on rai_interfaces to setup docs
maciejmajek e9adc10
docs: minor improvements
maciejmajek 308e1d9
Update src/rai_core/README.md
maciejmajek 12295a2
docs: add virtualenv note
maciejmajek ec976a0
docs: update virtual environment info
maciejmajek eae5e43
docs: update demos instructions
maciejmajek ed4c356
Update docs/setup/install.md
maciejmajek fae79f0
Update docs/setup/install.md
maciejmajek 6c7f320
Update docs/setup/install.md
maciejmajek File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,6 +9,29 @@ It generates a comprehensive system prompt (embodiment info) for robots controll | |
|
||
--- | ||
|
||
## Installation | ||
|
||
1. Install rai whoami: | ||
|
||
```bash | ||
pip install rai-whoami | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same considerations for ubuntu 24.04 as in rai-core. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @maciejmajek I think it would be beneficial to mention the tip about ros2 packages here as well |
||
``` | ||
|
||
2. Initialize the global configuration file (if not already done): | ||
|
||
```bash | ||
rai-config-init | ||
``` | ||
|
||
3. Optionally install ROS 2 dependencies: | ||
|
||
```bash | ||
sudo apt install ros-${ROS_DISTRO}-rai-interfaces | ||
``` | ||
|
||
For more visit [robotecai.github.io/rai](https://robotecai.github.io/rai/) for the latest documentation, setup | ||
guide and tutorials. | ||
|
||
## How It Works | ||
|
||
Given a directory containing robot documentation (documents, images, URDFs), RAI Whoami processes these resources to produce a structured representation of the robot, including: | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would make it untoggled by default