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
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`).
16
+
ROS 2.0 is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed against the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS 2.0. You can download the latest binary packages from [ROS 2.0 build farm](http://ci.ros2.org/view/packaging/) and follow the instructions of [Linux](https://index.ros.org/doc/ros2/Installation/Linux-Install-Binary/)/[macOS](https://index.ros.org/doc/ros2/Installation/OSX-Install-Binary/)/[Windows](https://index.ros.org/doc/ros2/Installation/Windows-Install-Binary/) to setup the environment (If you want to run your apps on a stable release of ROS 2.0, e.g. crystal-clemmys, please see the section `Running on Stable Release of ROS 2.0`).
Alternatively, you can download the latest binary package of ROS2 from [here](http://ci.ros2.org/view/packaging/) and follow the instructions to setup the environment.
Alternatively, you can build ROS 2.0 from scratch. Please select the platform you want to work on, then reference the instructions of [Linux](https://index.ros.org/doc/ros2/Installation/Linux-Development-Setup/)/[macOS](https://index.ros.org/doc/ros2/Installation/OSX-Development-Setup/)/[Windows](https://index.ros.org/doc/ros2/Installation/Windows-Development-Setup/) to build ROS 2.0 (please build wiht flag `--merge-install`).
29
21
30
22
### Install `Node.js`
31
23
@@ -85,21 +77,18 @@ npm install
85
77
set PATH=<path\to\python 2.x>;%PATH%
86
78
```
87
79
88
-
## Install rclnodejs by npm
89
-
90
-
### Install from npmjs
80
+
## Running on Stable Release of ROS 2.0
91
81
92
-
Please run `npm i rclnodejs` to install the latest version **OR**`npm i rclnodejs@<version>`to install a specific version.
82
+
If you want to select a stable release of ROS 2.0 as your platform, we have a table to illustrate the relationship between some stable release with a specific verion of rclnodejs.
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.
89
+
* Install from npmjs: run `npm i rclnodejs@<version>` to install a specific version.
97
90
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:
There are also several useful examples under the `example` folder, which will show you how to use some important features, including `timer/subscription/publisher/client/service`, in `rclnodejs`. You are encouraged to try these examples to understand them.
130
+
There are also several useful examples under the `example` folder, which will show you how to use some important features, including `timer/subscription/publisher/client/service/time/node graph`. You are encouraged to try these examples to understand them.
142
131
143
132
## API Specification
144
133
145
-
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.
134
+
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.
135
+
136
+
To visit the on-line version, please navigate to http://robotwebtools.org/rclnodejs/docs/index.html in your browser.
0 commit comments