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
This PR reformats the README.md file to improve readability and consistency. The changes focus on repositioning a note about ROS 2 support and making various formatting improvements.
- Moved the note about ROS 2 LTS releases from the table footer to a proper blockquote position
- Applied consistent formatting to code blocks and notes throughout the document
- Improved spacing and formatting in various sections
Fix: #1259
\* rclnodejs development and maintenance is limited to the ROS 2 LTS releases and the Rolling development branch
9
+
> **Note:** rclnodejs development and maintenance is limited to the ROS 2 LTS releases and the Rolling development branch
10
10
11
11
**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.
-**Note:**to install rclnodejs from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#<branch>"` to your `package.json` dependency section.
51
+
>**Note:**To install rclnodejs from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#<branch>"` to your `package.json` dependency section.
52
52
53
53
See the [features](./docs/FEATURES.md) and try the [examples](https://github.com/RobotWebTools/rclnodejs/tree/develop/example) to get started.
54
54
55
55
## rclnodejs-cli
56
56
57
57
[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.
58
58
59
-
```
59
+
```bash
60
60
Usage: rclnodejs [command] [options]
61
61
62
62
Options:
@@ -112,7 +112,7 @@ See [TypeScript demos](https://github.com/RobotWebTools/rclnodejs/tree/develop/t
112
112
113
113
ROS client libraries convert IDL message descriptions into target language source code. rclnodejs provides the `generate-ros-messages` script to generate JavaScript message interface files and TypeScript declarations.
114
114
115
-
Example usage:
115
+
**Example usage:**
116
116
117
117
```javascript
118
118
import*asrclnodejsfrom'rclnodejs';
@@ -130,6 +130,8 @@ npx generate-ros-messages
130
130
131
131
Generated files are located at `<yourproject>/node_modules/rclnodejs/generated/`.
132
132
133
+
> **Note:** This step is not needed for rclnodejs > 1.5.0
134
+
133
135
### IDL Message Generation
134
136
135
137
In addition to the standard ROS2 message generation (`.msg`, `.srv`, and `.action`), rclnodejs provides advanced support for generating JavaScript message files directly from IDL (Interface Definition Language) files. This feature is particularly useful when working with custom IDL files or when you need more control over the message generation process.
@@ -140,8 +142,6 @@ To generate messages from IDL files, use the `generate-messages-idl` npm script:
140
142
npm run generate-messages-idl
141
143
```
142
144
143
-
\* This step is not needed for rclnodejs > 1.5.0
144
-
145
145
## Performance Benchmarks
146
146
147
147
Benchmark results for 1000 iterations with 1024KB messages (Ubuntu 24.04.3 WSL2, i7-1185G7):
0 commit comments