Fix readme

This commit is contained in:
Piv
2020-09-22 21:47:29 +09:30
parent be85d7d39e
commit 3cc661542b

View File

@@ -3,9 +3,8 @@
This library interacts with the RPLidar A1 using pure swift. It is designed to closely replicate the python rplidar library by Skoltech: https://github.com/SkoltechRobotics/rplidar/ This library interacts with the RPLidar A1 using pure swift. It is designed to closely replicate the python rplidar library by Skoltech: https://github.com/SkoltechRobotics/rplidar/
There may be support for RPLidar A2, however it is not available for testing at this time. There may be support for RPLidar A2, however it is not available for testing at this time.
Documentation is coming soon.
For a runnable example, see the Examples product. For a runnable example, see the Examples product.
``` swift run --product Examples ``` ``` swift run LidarExamples ```
Documentation can be generated using [swift-doc](https://github.com/SwiftDocOrg/swift-doc)