Skip to content

Commit be9d3e1

Browse files
author
Minggang Wang
committed
Update the README file
Fix #441
1 parent f7e86e1 commit be9d3e1

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ master | [![Build Status](https://travis-ci.org/RobotWebTools/rclnodejs.svg?bran
1313

1414
1.Build from scratch.
1515

16-
ROS is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed on the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS, so you have to build ROS from scratch at the present stage. Please select the platform you want to work on, then reference the instruction to build ROS.
16+
ROS is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed on the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS, so you have to build ROS from scratch at the present stage. Please select the platform you want to work on, then reference the instruction to build ROS (please build wiht flag `--merge-install`).
1717

1818
* [Linux](https://github.com/ros2/ros2/wiki/Linux-Development-Setup)
1919
* [macOS](https://github.com/ros2/ros2/wiki/OSX-Development-Setup)
@@ -85,6 +85,22 @@ npm install
8585
set PATH=<path\to\python 2.x>;%PATH%
8686
```
8787

88+
## Install rclnodejs by npm
89+
90+
### Install from npmjs
91+
92+
Please run `npm i rclnodjs` to install the latest version OR `npm i rclnodjs@<version>` to install a specific version.
93+
94+
### Install from GitHub
95+
96+
You can also install `rclnodejs` from Github to experience the latest features, please add the following line into the `dependencies` section of your `package.json` file.
97+
98+
```"rclnodejs": "RobotWebTools/rclnodejs"```
99+
100+
We don't offer a release of rclnodejs against a specific release of ROS 2, e.g. [bouncy-bolson](https://github.com/ros2/ros2/releases/tag/release-bouncy), as the one pubilshed on npmjs is always built against the master branch of ROS 2, but we do have the branch which is against a release of ROS 2 on GitHub. You can checkout the [branches](https://github.com/RobotWebTools/rclnodejs/branches) we have, then add it to your `package.json`, e.g. if you want to use ROS 2 Bouncy Bolson:
101+
102+
```"rclnodejs": "RobotWebTools/rclnodejs#bouncy-bolson"```
103+
88104
## Run Unit Test
89105

90106
[mocha](https://www.npmjs.com/package/mocha) is a javascript test framework for node.js, simply run the following command to run the unit test under `test` folder:
@@ -128,9 +144,9 @@ There are also several useful examples under the `example` folder, which will sh
128144

129145
The API spec is generated by `jsdoc`, you can manually run `npm run docs` to create them by yourself, or just use the existing documents under `docs` folder. To visit the on-line version, please navigate to http://robotwebtools.org/rclnodejs/docs/index.html in your browser.
130146

131-
## Experimental
147+
## Experimental - Deprecated
132148

133-
* [actionlib](https://github.com/RobotWebTools/rclnodejs/blob/develop/tutorials/actionlib.md)
149+
* [actionlib](https://github.com/RobotWebTools/rclnodejs/blob/develop/tutorials/actionlib.md) - as the [rcl](https://github.com/ros2/rcl) library has implemented the action related functions, we are going to drop this one and we don't garantee the current actionlib can work with [rclcpp](https://github.com/ros2/rclcpp).
134150

135151
## Get Involved
136152

0 commit comments

Comments
 (0)