diff --git a/README.md b/README.md index b6bce607..5d472bb8 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ rclnodejs.init().then(() => { node.spin(); }); ``` + ## Documentation + - [Installation](#installation) - [API Documentation](#api-documentation) - [Using TypeScript](#using-typescript) @@ -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 ``` @@ -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: @@ -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) +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
## License + This project abides by the [Apache License 2.0](https://github.com/RobotWebTools/rclnodejs/blob/develop/LICENSE).