Skip to content

Reorg the README structure #1182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 4, 2025
Merged

Reorg the README structure #1182

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ rclnodejs.init().then(() => {
- [API Documentation](#api-documentation)
- [Using TypeScript](#using-rclnodejs-with-typescript)
- [ROS2 Interface Message Generation](#ros2-interface-message-generation-important)
- [IDL Message Generation](#idl-message-generation)
- [Examples](https://github.com/RobotWebTools/rclnodejs/tree/develop/example)
- [Electron demo](https://github.com/RobotWebTools/rclnodejs/tree/develop/electron_demo)
- [Efficient Usage Tips](./docs/EFFICIENCY.md)
Expand Down Expand Up @@ -148,18 +147,6 @@ let stringMsgObject = rclnodejs.createMessageObject('std_msgs/msg/String');
stringMsgObject.data = 'hello world';
```

## IDL Message Generation

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.

### Running `generate-messages-idl`

To generate messages from IDL files, use the `generate-messages-idl` npm script:

```bash
npm run generate-messages-idl
```

### Maintaining Generated JavaScript Message Files

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

### IDL Message Generation

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.

#### Running `generate-messages-idl`

To generate messages from IDL files, use the `generate-messages-idl` npm script:

```bash
npm run generate-messages-idl
```

## Contributing

Please read the [Contributing Guide]() before making a pull request.
Expand Down
Loading