Skip to content

Commit 734f2db

Browse files
author
Minggang Wang
committed
Update README to add the instruction of using the binary package of ROS
1 parent e5b3f5e commit 734f2db

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,31 @@
11
# rclnodejs - ROS Client Library for JavaScript language
22

3-
Branch | Linux Build | MacOS Build | Windows Build |
3+
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

88
## Build Environment
99

10-
1.Building ROS 2.
10+
### Get ready for ROS 2
1111

12-
Currently, the 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.
12+
1.Build from scratch.
13+
14+
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.
1315

1416
* [Linux](https://github.com/ros2/ros2/wiki/Linux-Development-Setup)
15-
* [MacOS](https://github.com/ros2/ros2/wiki/OSX-Development-Setup)
17+
* [macOS](https://github.com/ros2/ros2/wiki/OSX-Development-Setup)
1618
* [Windows](https://github.com/ros2/ros2/wiki/Windows-Development-Setup)
1719

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

2030
The `Node.js` version we selected is the latest LTS (6.x) `Boron`. You can install it:
2131

0 commit comments

Comments
 (0)