Skip to content

Commit a864760

Browse files
committed
feat: Update README
1 parent 5a2785e commit a864760

File tree

1 file changed

+25
-8
lines changed

1 file changed

+25
-8
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Coffee Buddy Robot
22

33
![Platform Support](https://img.shields.io/badge/Platform-Ubuntu%20%7C%20macOS-brightgreen)
4-
![ROS2](https://img.shields.io/badge/ROS2-Jazzy-blue)
4+
![ROS2](https://img.shields.io/badge/ROS2-Humble-blue)
55
![Python](https://img.shields.io/badge/Python-3.12-blue)
66

77
## Overview
@@ -45,6 +45,9 @@ cd coffee-buddy
4545
# Run automated setup (works on both Ubuntu and macOS)
4646
bash scripts/setup_workspace.sh
4747

48+
# For specific ROS2 distribution (if needed)
49+
bash scripts/setup_workspace.sh --ros-distro humble
50+
4851
# Activate the development environment
4952
source scripts/activate_workspace.sh
5053
```
@@ -109,11 +112,11 @@ The setup script handles all platform differences automatically:
109112
# Setup everything
110113
bash scripts/setup_workspace.sh --help # See all options
111114

112-
# Default setup (ROS2 Jazzy)
115+
# Default setup (ROS2 Humble)
113116
bash scripts/setup_workspace.sh
114117

115-
# With specific ROS2 distribution
116-
bash scripts/setup_workspace.sh --ros-distro humble
118+
# With specific ROS2 distribution (e.g., for Jazzy)
119+
bash scripts/setup_workspace.sh --ros-distro jazzy
117120

118121
# Clean installation (removes existing environment)
119122
bash scripts/setup_workspace.sh --clean
@@ -122,9 +125,15 @@ bash scripts/setup_workspace.sh --clean
122125
### Daily Usage
123126

124127
```bash
125-
# Activate development environment
128+
# Activate development environment (default: ros_env, humble)
126129
source scripts/activate_workspace.sh
127130

131+
# Activate with specific environment name
132+
source scripts/activate_workspace.sh my_ros_env
133+
134+
# Activate with specific ROS2 distribution
135+
source scripts/activate_workspace.sh ros_env humble
136+
128137
# Build packages (if needed)
129138
colcon build --symlink-install
130139

@@ -139,15 +148,15 @@ ros2 run <package> <executable>
139148

140149
**Ubuntu 24.04:**
141150
```bash
142-
# Install ROS2 Jazzy
151+
# Install ROS2 Humble
143152
sudo apt update
144153
sudo apt install software-properties-common
145154
sudo add-apt-repository universe
146155
sudo apt update && sudo apt install curl -y
147156
sudo curl -sSL https://raw.githubusercontent.com/ros/rosdistro/master/ros.key -o /usr/share/keyrings/ros-archive-keyring.gpg
148157
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/ros-archive-keyring.gpg] http://packages.ros.org/ros2/ubuntu $(. /etc/os-release && echo $UBUNTU_CODENAME) main" | sudo tee /etc/apt/sources.list.d/ros2.list > /dev/null
149158
sudo apt update
150-
sudo apt install ros-jazzy-desktop python3-colcon-common-extensions python3-rosdep python3-pip
159+
sudo apt install ros-humble-desktop python3-colcon-common-extensions python3-rosdep python3-pip
151160

152161
# Audio dependencies
153162
sudo apt install portaudio19-dev
@@ -167,7 +176,7 @@ colcon build --symlink-install
167176
# Install RoboStack environment
168177
mamba create -n ros_env
169178
mamba activate ros_env
170-
mamba install ros-jazzy-desktop compilers cmake pkg-config make ninja colcon-common-extensions rosdep python pip
179+
mamba install ros-humble-desktop compilers cmake pkg-config make ninja colcon-common-extensions rosdep python pip
171180

172181
# Audio dependencies
173182
brew install portaudio
@@ -267,6 +276,10 @@ colcon test --packages-select my_package
267276
# Platform-specific testing
268277
source scripts/activate_workspace.sh
269278
ros2 run my_package my_executable
279+
280+
# Test with different ROS2 distributions
281+
source scripts/activate_workspace.sh ros_env jazzy
282+
ros2 run my_package my_executable
270283
```
271284

272285
## Troubleshooting
@@ -351,6 +364,10 @@ cd coffee-buddy
351364
bash scripts/setup_workspace.sh
352365
source scripts/activate_workspace.sh
353366

367+
# Or with specific ROS2 distribution
368+
bash scripts/setup_workspace.sh --ros-distro humble
369+
source scripts/activate_workspace.sh ros_env humble
370+
354371
# Create feature branch
355372
git checkout -b feature/your-feature
356373

0 commit comments

Comments
 (0)