Skip to content

Commit 34454d8

Browse files
committed
docs: update rai core and whoami readmes
1 parent 245efa9 commit 34454d8

File tree

2 files changed

+46
-5
lines changed

2 files changed

+46
-5
lines changed

src/rai_core/README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,6 @@
22

33
RAI is a flexible AI agent framework to develop and deploy Embodied AI features for your robots.
44

5-
📚 Visit [robotecai.github.io/rai](https://robotecai.github.io/rai/) for the latest documentation, setup
6-
guide and tutorials. 📚
7-
8-
---
9-
105
<div align="center">
116

127
![rai-image](https://raw.githubusercontent.com/RobotecAI/rai/refs/heads/development/docs/imgs/RAI_simple_diagram_medium.png)
@@ -30,6 +25,29 @@ guide and tutorials. 📚
3025

3126
---
3227

28+
## Installation
29+
30+
1. Install RAI:
31+
32+
```bash
33+
pip install rai
34+
```
35+
36+
2. Initialize the global configuration file:
37+
38+
```bash
39+
rai-config-init
40+
```
41+
42+
3. Optionally install ROS 2 dependencies:
43+
44+
```bash
45+
sudo apt install ros-${ROS_DISTRO}-rai-interfaces
46+
```
47+
48+
For more visit [robotecai.github.io/rai](https://robotecai.github.io/rai/) for the latest documentation, setup
49+
guide and tutorials.
50+
3351
## 🎯 Overview
3452

3553
| Category | Description | Features |

src/rai_whoami/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,29 @@ It generates a comprehensive system prompt (embodiment info) for robots controll
99

1010
---
1111

12+
## Installation
13+
14+
1. Install rai whoami:
15+
16+
```bash
17+
pip install rai-whoami
18+
```
19+
20+
2. Initialize the global configuration file (if not already done):
21+
22+
```bash
23+
rai-config-init
24+
```
25+
26+
3. Optionally install ROS 2 dependencies:
27+
28+
```bash
29+
sudo apt install ros-${ROS_DISTRO}-rai-interfaces
30+
```
31+
32+
For more visit [robotecai.github.io/rai](https://robotecai.github.io/rai/) for the latest documentation, setup
33+
guide and tutorials.
34+
1235
## How It Works
1336

1437
Given a directory containing robot documentation (documents, images, URDFs), RAI Whoami processes these resources to produce a structured representation of the robot, including:

0 commit comments

Comments
 (0)