Skip to content

Commit bf5bab8

Browse files
committed
[Docs] Surface ROS 2 Lyrical and the 2.0.0-beta.0 baseline
1 parent 0c9d469 commit bf5bab8

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
| **ROS 2 Distro** | **CI Status** |
1111
| :---: | :---: |
12-
| [![ROS 2](https://img.shields.io/badge/ROS%202-Humble%20%7C%20Jazzy%20%7C%20Kilted%20%7C%20Rolling-blue?logo=ros)](https://www.ros.org/) | [![Linux x64](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-x64-push-test.yml/badge.svg?branch=develop)](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-x64-push-test.yml?query=branch%3Adevelop)<br>[![Linux arm64](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-arm64-push-test.yml/badge.svg?branch=develop)](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-arm64-push-test.yml?query=branch%3Adevelop)<br>[![Windows](https://github.com/RobotWebTools/rclnodejs/actions/workflows/windows-push-test.yml/badge.svg?branch=develop)](https://github.com/RobotWebTools/rclnodejs/actions/workflows/windows-push-test.yml?query=branch%3Adevelop)<br>[![ASan](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-x64-asan-test.yml/badge.svg?branch=develop)](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-x64-asan-test.yml?query=branch%3Adevelop) |
12+
| [![ROS 2](https://img.shields.io/badge/ROS%202-Humble%20%7C%20Jazzy%20%7C%20Kilted%20%7C%20Lyrical%20%7C%20Rolling-blue?logo=ros)](https://www.ros.org/) | [![Linux x64](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-x64-push-test.yml/badge.svg?branch=develop)](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-x64-push-test.yml?query=branch%3Adevelop)<br>[![Linux arm64](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-arm64-push-test.yml/badge.svg?branch=develop)](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-arm64-push-test.yml?query=branch%3Adevelop)<br>[![Windows](https://github.com/RobotWebTools/rclnodejs/actions/workflows/windows-push-test.yml/badge.svg?branch=develop)](https://github.com/RobotWebTools/rclnodejs/actions/workflows/windows-push-test.yml?query=branch%3Adevelop)<br>[![ASan](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-x64-asan-test.yml/badge.svg?branch=develop)](https://github.com/RobotWebTools/rclnodejs/actions/workflows/linux-x64-asan-test.yml?query=branch%3Adevelop) |
1313

1414
**rclnodejs** is a Node.js client library for [ROS 2](https://www.ros.org/) that provides comprehensive JavaScript and TypeScript APIs for developing ROS 2 solutions.
1515

@@ -48,7 +48,7 @@ Choose the path that matches how you plan to use rclnodejs:
4848
### Prerequisites
4949

5050
- [Node.js](https://nodejs.org/en/) version >= 20.20.2
51-
- [ROS 2 SDK](https://docs.ros.org/en/jazzy/Installation.html)
51+
- [ROS 2 SDK](https://docs.ros.org/en/lyrical/Installation.html)
5252

5353
Before installing, building, or running rclnodejs, source your ROS 2 environment:
5454

@@ -90,6 +90,7 @@ rclnodejs ships with prebuilt native binaries for common Linux configurations si
9090

9191
- **Ubuntu 22.04 (Jammy)** - ROS 2 Humble
9292
- **Ubuntu 24.04 (Noble)** - ROS 2 Jazzy, Kilted
93+
- **Ubuntu 26.04 (Resolute)** - ROS 2 Lyrical
9394
- **Architectures:** x64, arm64
9495
- **Node.js:** >= 20.20.2 (N-API compatible)
9596

@@ -202,7 +203,7 @@ See the [Observable Subscriptions Tutorial](./tutorials/observable-subscriptions
202203

203204
> A tiny WebSocket gateway to ROS 2 — built into `rclnodejs`.
204205
205-
> **Availability:** experimental; currently only on the `develop` branch and not yet part of any published `rclnodejs` release.
206+
> **Availability:** new in `2.0.0-beta.0`.
206207
207208
**rosocket** exposes ROS 2 topics/services as plain WebSocket URLs — a
208209
**lightweight** alternative to the rosbridge + roslibjs stack. Zero browser

docs/BUILDING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
1.Install ROS 2 from binary package.
66

7-
ROS 2 is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed against the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS 2. You can download the latest binary packages from [ROS 2 build farm](http://ci.ros2.org/view/packaging/) and follow the instructions of [Linux](https://docs.ros.org/en/rolling/Installation/Ubuntu-Install-Debians.html)/[Windows](https://docs.ros.org/en/rolling/Installation/Windows-Install-Binary.html) to setup the environment. Supported ROS 2 distributions: Rolling, Kilted, Jazzy, and Humble.
7+
ROS 2 is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed against the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS 2. You can download the latest binary packages from [ROS 2 build farm](http://ci.ros2.org/view/packaging/) and follow the instructions of [Linux](https://docs.ros.org/en/rolling/Installation/Ubuntu-Install-Debians.html)/[Windows](https://docs.ros.org/en/rolling/Installation/Windows-Install-Binary.html) to setup the environment. Supported ROS 2 distributions: Rolling, Lyrical, Kilted, Jazzy, and Humble.
88

99
2.Build ROS 2 from scratch.
1010

scripts/npmjs-readme.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
`rclnodejs` is a Node.js client library for ROS 2 that provides JavaScript and TypeScript APIs for building ROS 2 applications.
44

5-
Supported ROS 2 distributions include Humble, Jazzy, Kilted, and Rolling.
5+
Supported ROS 2 distributions include Humble, Jazzy, Kilted, Lyrical, and Rolling.
66

77
```javascript
88
const rclnodejs = require('rclnodejs');
@@ -21,7 +21,7 @@ This example assumes your ROS 2 environment is already sourced.
2121
### Prerequisites
2222

2323
- [Node.js](https://nodejs.org/en/) version >= 20.20.2
24-
- [ROS 2 SDK](https://docs.ros.org/en/jazzy/Installation.html)
24+
- [ROS 2 SDK](https://docs.ros.org/en/lyrical/Installation.html)
2525

2626
Before installing or running rclnodejs, source your ROS 2 environment:
2727

@@ -51,6 +51,7 @@ rclnodejs ships with prebuilt native binaries for common Linux configurations si
5151

5252
- **Ubuntu 22.04 (Jammy)** - ROS 2 Humble
5353
- **Ubuntu 24.04 (Noble)** - ROS 2 Jazzy, Kilted
54+
- **Ubuntu 26.04 (Resolute)** - ROS 2 Lyrical
5455
- **Architectures:** x64, arm64
5556
- **Node.js:** >= 20.20.2 (N-API compatible)
5657

0 commit comments

Comments
 (0)