You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: scripts/npmjs-readme.md
+20Lines changed: 20 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,26 @@ npm i rclnodejs
31
31
32
32
-**Note:** to install rclnodejs from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#<branch>"` to your `package.json` dependency section.
33
33
34
+
### Prebuilt Binaries
35
+
36
+
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.
37
+
38
+
**Supported Platforms:**
39
+
40
+
-**Ubuntu 22.04 (Jammy)** - ROS 2 Humble
41
+
-**Ubuntu 24.04 (Noble)** - ROS 2 Jazzy, Kilted
42
+
-**Architectures:** x64, arm64
43
+
-**Node.js:** >= 16.20.2 (N-API compatible)
44
+
45
+
**Force Building from Source:**
46
+
47
+
If you need to build from source even when a prebuilt binary is available, set the environment variable:
48
+
49
+
```bash
50
+
export RCLNODEJS_FORCE_BUILD=1
51
+
npm install rclnodejs
52
+
```
53
+
34
54
## Documentation
35
55
36
56
API [documentation](https://robotwebtools.github.io/rclnodejs/docs/index.html) is available online.
0 commit comments