Skip to content

Commit 94e17e9

Browse files
committed
Revise README
1 parent e872d09 commit 94e17e9

File tree

6 files changed

+20
-6
lines changed

6 files changed

+20
-6
lines changed

.github/workflows/prebuild-linux-arm64.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ name: Prebuild Linux ARM64
22

33
on:
44
workflow_dispatch:
5-
pull_request:
6-
branches:
7-
- develop
85
push:
96
tags:
107
- '*'

.github/workflows/prebuild-linux-x64.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,6 @@ name: Prebuild Linux x64
22

33
on:
44
workflow_dispatch:
5-
pull_request:
6-
branches:
7-
- develop
85
push:
96
tags:
107
- '*'

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,26 @@ npm i rclnodejs
5454
5555
See the [features](./docs/FEATURES.md) and try the [examples](https://github.com/RobotWebTools/rclnodejs/tree/develop/example) to get started.
5656

57+
### Prebuilt Binaries
58+
59+
rclnodejs ships with prebuilt native binaries for common Linux configurations since `v1.5.2`, eliminating the need for compilation during installation. This significantly speeds up installation and reduces dependencies.
60+
61+
**Supported Platforms:**
62+
63+
- **Ubuntu 22.04 (Jammy)** - ROS 2 Humble
64+
- **Ubuntu 24.04 (Noble)** - ROS 2 Jazzy, Kilted, Rolling
65+
- **Architectures:** x64, arm64
66+
- **Node.js:** >= 16.20.2 (N-API compatible)
67+
68+
**Force Building from Source:**
69+
70+
If you need to build from source even when a prebuilt binary is available, set the environment variable:
71+
72+
```bash
73+
export RCLNODEJS_FORCE_BUILD=1
74+
npm install rclnodejs
75+
```
76+
5777
## rclnodejs-cli
5878

5979
[rclnodejs-cli](https://github.com/RobotWebTools/rclnodejs-cli/) is a companion project we recently launched to provide a commandline interface to a set of developer tools for working with this `rclnodejs`. You may find `rclnodejs-cli` particularly useful if you plan to create ROS 2 node(s) and launch files for working with multiple node orchestrations.
-646 KB
Binary file not shown.
-806 KB
Binary file not shown.
-814 KB
Binary file not shown.

0 commit comments

Comments
 (0)