Skip to content

Commit a58f88f

Browse files
author
Minggang Wang
committed
Update README to add version information supporting Dashing
Fix #NONE
1 parent fe65be9 commit a58f88f

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,25 @@
1-
# rclnodejs - ROS Client Library for JavaScript language[![Coverage Status](https://coveralls.io/repos/github/RobotWebTools/rclnodejs/badge.svg?branch=develop)](https://coveralls.io/github/RobotWebTools/rclnodejs?branch=develop)[![npm](https://img.shields.io/npm/dt/rclnodejs.svg)](https://www.npmjs.com/package/rclnodejs)[![GitHub license](https://img.shields.io/github/license/RobotWebTools/rclnodejs.svg)](https://github.com/RobotWebTools/rclnodejs/blob/develop/LICENSE)[![node](https://img.shields.io/node/v/rclnodejs.svg)](https://nodejs.org/en/download/releases/)[![dependencies Status](https://david-dm.org/RobotWebTools/rclnodejs/status.svg)](https://david-dm.org/RobotWebTools/rclnodejs)
1+
# rclnodejs - ROS Client Library for JavaScript language![npm](https://img.shields.io/npm/v/rclnodejs.svg)[![Coverage Status](https://coveralls.io/repos/github/RobotWebTools/rclnodejs/badge.svg?branch=develop)](https://coveralls.io/github/RobotWebTools/rclnodejs?branch=develop)[![npm](https://img.shields.io/npm/dt/rclnodejs.svg)](https://www.npmjs.com/package/rclnodejs)[![GitHub license](https://img.shields.io/github/license/RobotWebTools/rclnodejs.svg)](https://github.com/RobotWebTools/rclnodejs/blob/develop/LICENSE)[![node](https://img.shields.io/node/v/rclnodejs.svg)](https://nodejs.org/en/download/releases/)[![dependencies Status](https://david-dm.org/RobotWebTools/rclnodejs/status.svg)](https://david-dm.org/RobotWebTools/rclnodejs)
22

33
Branch | Linux Build | macOS Build | Windows Build |
44
------------ | :-------------: | :-------------: | :-------------: |
55
develop | [![Build Status](https://travis-ci.org/RobotWebTools/rclnodejs.svg?branch=develop)](https://travis-ci.org/RobotWebTools/rclnodejs) | [![macOS Build Status](https://circleci.com/gh/RobotWebTools/rclnodejs/tree/develop.svg?style=shield)](https://circleci.com/gh/RobotWebTools/rclnodejs) | [![Build status](https://ci.appveyor.com/api/projects/status/upbc7tavdag1aa5e/branch/develop?svg=true)](https://ci.appveyor.com/project/minggangw/rclnodejs/branch/develop)
66
master | [![Build Status](https://travis-ci.org/RobotWebTools/rclnodejs.svg?branch=master)](https://travis-ci.org/RobotWebTools/rclnodejs) | [![macOS Build Status](https://circleci.com/gh/RobotWebTools/rclnodejs/tree/master.svg?style=shield)](https://circleci.com/gh/RobotWebTools/rclnodejs) | [![Build status](https://ci.appveyor.com/api/projects/status/upbc7tavdag1aa5e/branch/master?svg=true)](https://ci.appveyor.com/project/minggangw/rclnodejs/branch/master)
77

8-
[![NPM](https://nodei.co/npm/rclnodejs.png)](https://nodei.co/npm/rclnodejs/)
8+
## Match with ROS 2.0 Stable Releases
9+
10+
If you want to select a stable release of ROS 2.0 as your platform, please check the table below.
911

10-
## Build Environment
12+
ROS 2.0 release | NPM version |
13+
:------------: | :-------------: |
14+
Dashing Diademata Patch Release [1](https://github.com/ros2/ros2/releases/tag/release-dashing-20190614) | [0.10.0](https://www.npmjs.com/package/rclnodejs/v/0.10.0) |
15+
Crystal Clemmys Patch Release [1](https://github.com/ros2/ros2/releases/tag/release-crystal-20190117)/[2](https://github.com/ros2/ros2/releases/tag/release-crystal-20190214)/[3](https://github.com/ros2/ros2/releases/tag/release-crystal-20190314)/[4](https://github.com/ros2/ros2/releases/tag/release-crystal-20190408)| [0.9.0](https://www.npmjs.com/package/rclnodejs/v/0.9.0) | [crystal-clemmys](https://github.com/RobotWebTools/rclnodejs/tree/crystal-clemmys) |
16+
[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)
17+
18+
* Install from npmjs: run `npm i rclnodejs@<version>` to install a specific version.
19+
20+
* Install from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#<branch>"` to your `package.json`.
21+
22+
## Build from Scratch
1123

1224
### Get ready for ROS 2
1325

@@ -29,7 +41,7 @@ The `Node.js` version we selected is the latest LTS [`Carbon`](https://nodejs.or
2941
* Download from Node.js offical [website](https://nodejs.org/en/), and install it.
3042
* Use the Node Version Manager ([nvm](https://github.com/creationix/nvm)) to install it.
3143

32-
## Get Code
44+
### Get Code
3345

3446
Open a terminal, and input:
3547

@@ -43,7 +55,7 @@ then enter the folder `rclnodejs`, and get the submodule:
4355
git submodule update --init --recursive
4456
```
4557

46-
## Build Module
58+
### Build Module
4759

4860
Before you build the module, you should make sure the ROS2 environments were loaded. You can check if the `COLCON_PREFIX_PATH` environment variable was set:
4961

@@ -77,19 +89,6 @@ npm install
7789
set PATH=<path\to\python 2.x>;%PATH%
7890
```
7991

80-
## Match with ROS 2.0 Stable Releases
81-
82-
If you want to select a stable release of ROS 2.0 as your platform, please check the table below.
83-
84-
ROS 2.0 release | NPM version |
85-
:------------: | :-------------: |
86-
Crystal Clemmys Patch Release [1](https://github.com/ros2/ros2/releases/tag/release-crystal-20190117)/[2](https://github.com/ros2/ros2/releases/tag/release-crystal-20190214)/[3](https://github.com/ros2/ros2/releases/tag/release-crystal-20190314)/[4](https://github.com/ros2/ros2/releases/tag/release-crystal-20190408)| [0.9.0](https://www.npmjs.com/package/rclnodejs/v/0.9.0) | [crystal-clemmys](https://github.com/RobotWebTools/rclnodejs/tree/crystal-clemmys) |
87-
[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)
88-
89-
* Install from npmjs: run `npm i rclnodejs@<version>` to install a specific version.
90-
91-
* Install from GitHub: add `"rclnodejs":"RobotWebTools/rclnodejs#<branch>"` to your `package.json`.
92-
9392
## Run Unit Test
9493

9594
[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:

0 commit comments

Comments
 (0)