Skip to content

Commit 355d463

Browse files
authored
Merge pull request #133 from mini-1235/patch-1
Add Lyrical and Rolling
2 parents e8aa247 + da38b9a commit 355d463

3 files changed

Lines changed: 68 additions & 4 deletions

File tree

docs/Contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,13 @@ To make code review easier, please consider manually porting the new hunks into
5252
Clone the relevant repo:
5353

5454
```bash
55-
git clone https://github.com/RoboStack/ros-humble.git # or: git clone https://github.com/RoboStack/ros-noetic.git or git clone https://github.com/RoboStack/ros-jazzy.git or git clone https://github.com/RoboStack/ros-kilted.git
55+
git clone https://github.com/RoboStack/ros-humble.git # or: git clone https://github.com/RoboStack/ros-noetic.git or git clone https://github.com/RoboStack/ros-jazzy.git or git clone https://github.com/RoboStack/ros-kilted.git or git clone https://github.com/RoboStack/ros-lyrical.git or git clone https://github.com/RoboStack/ros-rolling.git
5656
```
5757

5858
Then move in the newly cloned repo, and if necessary do any change to the `vinca_*.yaml` file for your platform:
5959

6060
```bash
61-
cd ros-humble # or: cd ros-noetic or cd ros-jazzy or cd ros-kilted
61+
cd ros-humble # or: cd ros-noetic or cd ros-jazzy or cd ros-kilted or cd ros-lyrical or cd ros-rolling
6262
```
6363

6464
Then you can build the packages that need to be built after the `vinca_***.yaml` changes with:

docs/GettingStarted.md

Lines changed: 64 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,26 @@ Note that the instructions for Conda and Micromamba are virtually identical apar
7070
# Add the robostack channel to the environemnt
7171
micromamba config append channels robostack-kilted --env
7272
```
73+
=== "ROS 2 Lyrical"
74+
```bash
75+
# Create a ros-lyrical desktop environment
76+
micromamba create -n ros_env -c conda-forge -c robostack-lyrical ros-lyrical-desktop
77+
# Activate the environment
78+
micromamba activate ros_env
79+
# Add the robostack channel to the environemnt
80+
micromamba config append channels robostack-lyrical --env
81+
```
82+
83+
=== "ROS 2 Rolling"
84+
```bash
85+
# Create a ros-rolling desktop environment
86+
micromamba create -n ros_env -c conda-forge -c robostack-rolling ros-rolling-desktop
87+
# Activate the environment
88+
micromamba activate ros_env
89+
# Add the robostack channel to the environemnt
90+
micromamba config append channels robostack-rolling --env
91+
```
92+
7393

7494
## Installing tools for local development
7595
```bash title="Default tools to help with local development of ROS packages"
@@ -145,6 +165,26 @@ Note that the instructions for Conda and Micromamba are virtually identical apar
145165
# Add the robostack channel to the environemnt
146166
conda config --env --add channels robostack-kilted
147167
```
168+
169+
=== "ROS 2 Lyrical"
170+
```bash
171+
# Create a ros-lyrical desktop environment
172+
conda create -n ros_env -c conda-forge -c robostack-lyrical ros-lyrical-desktop
173+
# Activate the environment
174+
conda activate ros_env
175+
# Add the robostack channel to the environemnt
176+
conda config --env --add channels robostack-lyrical
177+
```
178+
179+
=== "ROS 2 Rolling"
180+
```bash
181+
# Create a ros-rolling desktop environment
182+
conda create -n ros_env -c conda-forge -c robostack-rolling ros-rolling-desktop
183+
# Activate the environment
184+
conda activate ros_env
185+
# Add the robostack channel to the environemnt
186+
conda config --env --add channels robostack-rolling
187+
```
148188

149189
## Installing tools for local development
150190
```bash title="Default tools to help with local development of ROS packages"
@@ -248,6 +288,8 @@ Note that the instructions for Conda and Micromamba are virtually identical apar
248288
humble = { features = ["humble", "build"] }
249289
jazzy = { features = ["jazzy", "build"] }
250290
kilted = { features = ["kilted", "build"] }
291+
lyrical = { features = ["lyrical", "build"] }
292+
rolling = { features = ["rolling", "build"] }
251293

252294
### ROS Noetic ####
253295
[feature.noetic]
@@ -277,6 +319,20 @@ Note that the instructions for Conda and Micromamba are virtually identical apar
277319

278320
[feature.kilted.dependencies]
279321
ros-kilted-desktop = "*"
322+
323+
### ROS Lyrical ####
324+
[feature.lyrical]
325+
channels = ["https://prefix.dev/robostack-lyrical"]
326+
327+
[feature.lyrical.dependencies]
328+
ros-lyrical-desktop = "*"
329+
330+
### ROS Rolling ####
331+
[feature.rolling]
332+
channels = ["https://prefix.dev/robostack-rolling"]
333+
334+
[feature.rolling.dependencies]
335+
ros-rolling-desktop = "*"
280336
```
281337

282338
```bash
@@ -295,6 +351,12 @@ Note that the instructions for Conda and Micromamba are virtually identical apar
295351

296352
# ROS kilted
297353
pixi shell -e kilted
354+
355+
# ROS lyrical
356+
pixi shell -e lyrical
357+
358+
# ROS rolling
359+
pixi shell -e rolling
298360
```
299361

300362
## Testing installation
@@ -408,12 +470,12 @@ After installation, you should test if you are able to run `rviz`/`rviz2` and ot
408470
**ROS 2**
409471
```bash title="Terminal"
410472
cd robostack
411-
pixi run -e humble rviz2 # OR jazzy, kilted
473+
pixi run -e humble rviz2 # OR jazzy, kilted, lyrical, rolling
412474
```
413475
alternatively,
414476
```bash title="Terminal"
415477
cd robostack
416-
pixi shell -e humble # OR jazzy, kilted
478+
pixi shell -e humble # OR jazzy, kilted, lyrical, rolling
417479
rviz2
418480
```
419481

docs/support.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ You can also contribute by following the guidelines in our [contribution](Contri
1717
* [ROS2 Humble](https://github.com/RoboStack/ros-humble/issues/new/choose)
1818
* [ROS2 Jazzy](https://github.com/RoboStack/ros-jazzy/issues/new/choose)
1919
* [ROS2 Kilted](https://github.com/RoboStack/ros-kilted/issues/new/choose)
20+
* [ROS2 Lyrical](https://github.com/RoboStack/ros-lyrical/issues/new/choose)
21+
* [ROS2 Rolling](https://github.com/RoboStack/ros-rolling/issues/new/choose)
2022
* [ROS2 Galactic](https://github.com/RoboStack/ros-galactic/issues/new/choose) (not actively maintained anymore)
2123
* [ROS2 Foxy](https://github.com/RoboStack/ros-foxy/issues/new/choose) (not actively maintained anymore)
2224

0 commit comments

Comments
 (0)