Skip to content

Commit 095bda3

Browse files
author
Minggang Wang
committed
Correct the links used in README
Fix #455
1 parent 725b6d5 commit 095bda3

File tree

2 files changed

+18
-26
lines changed

2 files changed

+18
-26
lines changed

README.md

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,13 @@ master | [![Build Status](https://travis-ci.org/RobotWebTools/rclnodejs.svg?bran
1111

1212
### Get ready for ROS 2
1313

14-
1.Build from scratch.
14+
1.Install ROS 2.0 from binary package.
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 (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`).
1717

18-
* [Linux](https://github.com/ros2/ros2/wiki/Linux-Development-Setup)
19-
* [macOS](https://github.com/ros2/ros2/wiki/OSX-Development-Setup)
20-
* [Windows](https://github.com/ros2/ros2/wiki/Windows-Development-Setup)
18+
2.Build ROS 2.0 from scratch.
2119

22-
2.Get the binary package.
23-
24-
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.
25-
26-
* [Linux](https://github.com/ros2/ros2/wiki/Linux-Install-Binary)
27-
* [macOS](https://github.com/ros2/ros2/wiki/OSX-Install-Binary)
28-
* [Windows](https://github.com/ros2/ros2/wiki/Windows-Install-Binary)
20+
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`).
2921

3022
### Install `Node.js`
3123

@@ -85,21 +77,18 @@ npm install
8577
set PATH=<path\to\python 2.x>;%PATH%
8678
```
8779

88-
## Install rclnodejs by npm
89-
90-
### Install from npmjs
80+
## Running on Stable Release of ROS 2.0
9181

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.
9383

94-
### Install from GitHub
84+
ROS 2.0 release | NPM version | Github branch |
85+
:------------: | :-------------: | :-------------: |
86+
[Bouncy Bolson](https://github.com/ros2/ros2/releases/tag/release-bouncy) | [0.3.5](https://www.npmjs.com/package/rclnodejs/v/0.3.5) | [bouncy-bolson](https://github.com/RobotWebTools/rclnodejs/tree/bouncy-bolson)
87+
[Crystal Clemmys](https://github.com/ros2/ros2/releases/tag/release-crystal-20181214) | [0.8.0](https://www.npmjs.com/package/rclnodejs/v/0.8.0) | [crystal-clemmys](https://github.com/RobotWebTools/rclnodejs/tree/crystal-clemmys)
9588

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.
89+
* Install from npmjs: run `npm i rclnodejs@<version>` to install a specific version.
9790

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"```
91+
* Install from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#<branch>"` to your `package.json`.
10392

10493
## Run Unit Test
10594

@@ -138,11 +127,13 @@ rclnodejs.init().then(() => {
138127
});
139128
```
140129

141-
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.
142131

143132
## API Specification
144133

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.
146137

147138
## Experimental - Deprecated
148139

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"rclnodejs",
88
"ros2",
99
"ros",
10-
"rcl"
10+
"rcl",
11+
"robotics"
1112
],
1213
"scripts": {
1314
"install": "node-gyp rebuild",

0 commit comments

Comments
 (0)