Skip to content

Commit 938f3d9

Browse files
wayneparrottMinggang Wang
authored andcommitted
Added new README section to rclnodejs-cli.
1 parent 597b7f9 commit 938f3d9

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ rclnodejs.init().then(() => {
2525
## Documentation
2626

2727
- [Installation](#installation)
28+
- [rclnodejs-cli](#rclnodejs-cli)
2829
- [API Documentation](#api-documentation)
2930
- [Using TypeScript](#using-typescript)
3031
- [Examples](https://github.com/RobotWebTools/rclnodejs/tree/develop/example)
@@ -66,6 +67,28 @@ npm i [email protected]
6667

6768
- **Note:** to install rclnodejs from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#<branch>"` to your `package.json` depdendency section.
6869

70+
## rclnodejs-cli
71+
72+
[rclnodejs-cli](https://github.com/RobotWebTools/rclnodejs/) 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.
73+
```
74+
_ _ _
75+
_ __ ___| |_ __ ___ __| | ___ (_)___
76+
| '__/ __| | '_ \ / _ \ / _` |/ _ \| / __|
77+
| | | (__| | | | | (_) | (_| | __/| \__ \
78+
|_| \___|_|_| |_|\___/ \__,_|\___|/ |___/
79+
|__/
80+
Usage: rclnodejs [command] [options]
81+
82+
Options:
83+
-h, --help display help for command
84+
85+
Commands:
86+
create-package [options] <package-name> Create a ROS2 package for Nodejs development.
87+
generate-ros-messages Generate JavaScript code from ROS2 IDL interfaces
88+
help [command] display help for command
89+
```
90+
91+
6992
## API Documentation
7093

7194
API documentation is generated by `jsdoc` and can be viewed in the `docs/` folder or [on-line](http://robotwebtools.org/rclnodejs/docs/index.html). To create a local copy of the documentation run `npm run docs`.

0 commit comments

Comments
 (0)