Skip to content

Commit

Permalink
Merge pull request #4 from westonrobot/feature-docs_update
Browse files Browse the repository at this point in the history
docs: update readme
  • Loading branch information
hanskw-weston authored May 31, 2024
2 parents 1a11561 + d1ec086 commit 45b740e
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [Weston Robot Platform SDK (wrp\_sdk)](#weston-robot-platform-sdk-wrp_sdk)
- [Table of Contents](#table-of-contents)
- [Description](#description)
- [Documentation](#documentation)
- [Features](#features)
- [Supported Platforms](#supported-platforms)
- [Supported Robot Bases](#supported-robot-bases)
Expand All @@ -17,7 +18,13 @@
## Description
wrp_sdk provides C++ interface to mobile robot bases and robot peripherals (IMU, Ultrasonic, GPS, Camera Lift, etc.) from Weston Robot.

wrp_sdk is provided as a **Debian installation package** only and you can install it by following the steps given below. For sample code, please check the appropriate version tags of this repository.
wrp_sdk is provided as a **Debian installation package** only and you can install it by following the steps given below.

* For the sample codes, please check the appropriate version tags of this repository.
* For another example of how to use the SDK, you can refer to [wrp_ros2](https://github.com/westonrobot/wrp_ros2) & [wrp_ros](https://github.com/westonrobot/wrp_ros)

## Documentation
* [wrp_sdk API Documentation](https://westonrobot.github.io/wrp_sdk/)

## Features
### Supported Platforms
Expand Down Expand Up @@ -58,7 +65,7 @@ $ sudo apt remove wrp-zbus wrp-sdk
$ sudo apt install wrp-sdk=1.0.7
```

You can also download compatible wrp_sdk and wrp_zbus debian installation packages from [Releases](https://github.com/westonrobot/wrp_sdk/releases). Please contact us at [support@westonrobot.com](mailto:support@westonrobot.com) if you're not sure which version of the SDK you should use.
You can also download compatible wrp_sdk and wrp_zbus debian installation packages from [Releases](https://github.com/westonrobot/wrp_sdk/releases). Please contact us ([refer below](#contact)) if you're not sure which version of the SDK you should use.

## Usage
Sample code demos are provided in the [sample folder](./sample/).
Expand All @@ -72,8 +79,8 @@ $ make -j8
You will get executable "sample_xxx" inside the build/bin folder.

## Contact
Please contact us at [support@westonrobot.com](mailto:support@westonrobot.com).
Documentation of the various robots are available at [docs.westonrobot.net](https://docs.westonrobot.net).
* For support and enquiries, please contact us through our [support form](https://forms.office.com/r/UXzrrsgEyW).
* Documentation of the various robots are available at [docs.westonrobot.com](https://docs.westonrobot.com).

## FAQ
* **Q1:** What's the difference between [ugv_sdk](https://github.com/westonrobot/ugv_sdk) and wrp_sdk?
Expand Down

0 comments on commit 45b740e

Please sign in to comment.