Skip to content

Commit f341d83

Browse files
authored
Reorg the README structure (#1182)
This PR restructures the README by moving the “IDL Message Generation” section to sit below the generated message maintenance instructions and updating its heading levels, while removing the old table-of-contents entry. - Removed outdated TOC entry and original section block - Re-added “IDL Message Generation” under “Maintaining Generated JavaScript Message Files” with proper `###`/`####` hierarchy Fix: #764
1 parent 9bbf409 commit f341d83

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ rclnodejs.init().then(() => {
3333
- [API Documentation](#api-documentation)
3434
- [Using TypeScript](#using-rclnodejs-with-typescript)
3535
- [ROS2 Interface Message Generation](#ros2-interface-message-generation-important)
36-
- [IDL Message Generation](#idl-message-generation)
3736
- [Examples](https://github.com/RobotWebTools/rclnodejs/tree/develop/example)
3837
- [Electron demo](https://github.com/RobotWebTools/rclnodejs/tree/develop/electron_demo)
3938
- [Efficient Usage Tips](./docs/EFFICIENCY.md)
@@ -148,18 +147,6 @@ let stringMsgObject = rclnodejs.createMessageObject('std_msgs/msg/String');
148147
stringMsgObject.data = 'hello world';
149148
```
150149

151-
## IDL Message Generation
152-
153-
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.
154-
155-
### Running `generate-messages-idl`
156-
157-
To generate messages from IDL files, use the `generate-messages-idl` npm script:
158-
159-
```bash
160-
npm run generate-messages-idl
161-
```
162-
163150
### Maintaining Generated JavaScript Message Files
164151

165152
Message files are generated as a post-install step of the rclnodejs
@@ -178,6 +165,18 @@ npx generate-ros-messages
178165
The newly generated JavaScript files can be found at
179166
`<yourproject>/node_modules/rclnodejs/generated/`.
180167

168+
### IDL Message Generation
169+
170+
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.
171+
172+
#### Running `generate-messages-idl`
173+
174+
To generate messages from IDL files, use the `generate-messages-idl` npm script:
175+
176+
```bash
177+
npm run generate-messages-idl
178+
```
179+
181180
## Contributing
182181

183182
Please read the [Contributing Guide]() before making a pull request.

0 commit comments

Comments
 (0)