diff --git a/README.md b/README.md index 4edac7e..b671186 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,14 @@ -# VL.NewLibrary.Template +# VL.Devices.RPLidar -- [ ] A clear and concise description of what this package is and does, also what problem it solves. -- [ ] In case this is a wrapper, links to original code and which version of it is used -- [ ] In case this is for a device/protocol, links to the device/protocol-specs -- [ ] Required dependencies/drivers to download and install in the getting started section below -- [ ] If available, links to documentation (other than helppatches), tutorial videos, blog posts, ... -- [ ] Note that you can also include screenshots! -- [ ] Mention any limitations +For using RPLIDAR [A1](https://www.slamtec.com/en/Lidar/A1), [A2](https://www.slamtec.com/en/Lidar/A2) and [A3](https://www.slamtec.com/en/Lidar/A3) devices by [Slamtec](http://slamtec.com) For use with vvvv, the visual live-programming environment for .NET: http://visualprogramming.net ## Getting started +- When connecting via USB, install [CP210x USB to UART Bridge](https://www.silabs.com/documents/public/software/CP210x_Universal_Windows_Driver.zip) for - Install as [described here](https://thegraybook.vvvv.org/reference/hde/managing-nugets.html) via commandline: - `nuget install VL.NewLibrary.Template -pre` + `nuget install VL.Devices.RPLidar -pre` - Usage examples and more information are included in the pack and can be found via the [Help Browser](https://thegraybook.vvvv.org/reference/hde/findinghelp.html) @@ -23,7 +18,7 @@ For use with vvvv, the visual live-programming environment for .NET: http://visu - When making a pull-request, please make sure to read the general [guidelines on contributing to vvvv libraries](https://thegraybook.vvvv.org/reference/extending/contributing.html) ## Credits -Links to libraries this is based on +Based on [RPLidar4Net.IO](https://www.nuget.org/packages/RPLidar4Net.IO) ## Sponsoring Development of this library was partially sponsored by: