vato007/swiftrplidar
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix readme

Browse Source
This commit is contained in:
Piv
2020-09-22 21:47:29 +09:30
parent be85d7d39e
commit 3cc661542b
1 changed files with 2 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
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/
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.
``` swift run --product Examples ```
``` swift run LidarExamples ```
Documentation can be generated using [swift-doc](https://github.com/SwiftDocOrg/swift-doc)