Skip to content

Complete the contributors list #770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 9, 2021
Merged

Complete the contributors list #770

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 39 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ rclnodejs.init().then(() => {
node.spin();
});
```

## Documentation

- [Installation](#installation)
- [API Documentation](#api-documentation)
- [Using TypeScript](#using-typescript)
Expand All @@ -30,18 +32,20 @@ rclnodejs.init().then(() => {
## Installation

### Prerequisites

Before installing `rclnodejs` please ensure the following softare is installed and configured on your systemd:

- [Nodejs](https://nodejs.org/en/) version between 8.12 - 12.x.

- [ROS 2 SDK](https://index.ros.org/doc/ros2/Installation/) for details.
**DON'T FORGET TO [SOURCE THE ROS 2 SETUP FILE](https://index.ros.org/doc/ros2/Tutorials/Configuring-ROS2-Environment/#source-the-setup-files)**
**DON'T FORGET TO [SOURCE THE ROS 2 SETUP FILE](https://index.ros.org/doc/ros2/Tutorials/Configuring-ROS2-Environment/#source-the-setup-files)**

### Installing rclnodejs

Install the rclnodejs version that is compatible with your version of ROS 2 (see table below).

For the most current version of rclnodejs run:

```bash
npm i rclnodejs
```
Expand All @@ -65,7 +69,7 @@ API documentation is generated by `jsdoc` and can be viewed in the `docs/` folde

## Using TypeScript

`rclnodejs` API can be used in TypeScript projects. You can find the TypeScript declaration files (\*.d.ts) in the `types/` folder.
`rclnodejs` API can be used in TypeScript projects. You can find the TypeScript declaration files (\*.d.ts) in the `types/` folder.

Your project `tsconfig.json` file should include the following compiler options:

Expand Down Expand Up @@ -106,8 +110,39 @@ Please make sure to read the [Contributing Guide]() before making a pull request

Thank you to all the [people](CONTRIBUTORS.md) who already contributed to rclnodejs!

[![](https://github.com/minggangw.png?size=25)](https://github.com/minggangw)
[![](https://github.com/wayneparrott.png?size=25)](https://github.com/wayneparrott)
<div>
<a href="https://github.com/wayneparrott">
<img src="https://github.com/wayneparrott.png" width="30">
</a>
<a href="https://github.com/koonpeng">
<img src="https://github.com/koonpeng.png" width="30">
</a>
<a href="https://github.com/mattrichard">
<img src="https://github.com/mattrichard.png" width="30">
</a>
<a href="https://github.com/felixdivo">
<img src="https://github.com/felixdivo.png" width="30">
</a>
<a href="https://github.com/martins-mozeiko">
<img src="https://github.com/martins-mozeiko.png" width="30">
</a>
<a href="https://github.com/amikhalev">
<img src="https://github.com/amikhalev.png" width="30">
</a>
<a href="https://github.com/kenny-y">
<img src="https://github.com/kenny-y.png" width="30">
</a>
<a href="https://github.com/qiuzhong">
<img src="https://github.com/qiuzhong.png" width="30">
</a>
<a href="https://github.com/minggangw">
<img src="https://github.com/minggangw.png" width="30">
</a>
<a href="https://github.com/hanyia">
<img src="https://github.com/hanyia.png" width="30">
</a>
</div>

## License

This project abides by the [Apache License 2.0](https://github.com/RobotWebTools/rclnodejs/blob/develop/LICENSE).