diff --git a/README.md b/README.md index 9e80757..1076817 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,17 @@ -NeatoC -====== +# NeatoC [![Build Status](https://travis-ci.org/branoholy/neatoc.svg?branch=master)](https://travis-ci.org/branoholy/neatoc) *A simple C++ library for communication with the Neato XV robot.* -`neatoc` allows you to communicate with the Neato robot through sockets. You -can use some implemented methods like `setMotor()`, `getLdsScan()`, or run any +`neatoc` allows you to communicate with the Neato robot through sockets. You +can use some implemented methods like `setMotor()`, `getLdsScan()`, or run any other command with the `sendCommand()` method. -Download --------- -You can download the source code and build `neatoc` according to +## Download +You can download the source code and build `neatoc` according to the [build instructions](#build) below. -Usage ------ +## Usage ```cpp // Create the controller neatoc::Controller controller; @@ -34,31 +31,29 @@ controller.setLdsRotation(false); controller.setTestMode(false); ``` -Dependencies ------------- +## Dependencies The library uses: -* [Boost.Asio](http://www.boost.org/doc/libs/release/doc/html/boost_asio.html) -library (version 1.59 or newer). It is necessary to link the `boost_system` +* [Boost.Asio](http://www.boost.org/doc/libs/release/doc/html/boost_asio.html) +library (version 1.54 or newer). It is necessary to link the `boost_system` library. -* [Boost String Algorithms Library](http://www.boost.org/doc/libs/release/doc/html/string_algo.html) -(version 1.59 or newer). +* [Boost String Algorithms Library](http://www.boost.org/doc/libs/release/doc/html/string_algo.html) +(version 1.54 or newer). The `neatoc-scan-gui` example also needs: * [wxWidgets](https://www.wxwidgets.org) library (version 3.0 or newer). -Build ------ +## Build Make sure you have installed all [dependencies](#dependencies) before building. ```bash $ mkdir build && cd build $ cmake .. -$ cmake --build . +$ make ``` -Use the following option if you want to build the [examples](https://github.com/branoholy/neatoc/tree/master/examples) +Use the following option if you want to build the [examples](https://github.com/branoholy/neatoc/tree/master/examples) as well: ```bash @@ -68,25 +63,35 @@ $ cmake -Dexamples:bool=on .. For faster build on a multicore processor, you can use: ```bash -$ cmake --build . -- -j4 +$ make -j$(nproc) ``` -Where the option `-j4` means you want to use 4 cores for building. +## Installation +To install the `neatoc` library (and its examples), simply run as root: -Examples --------- -See [examples](https://github.com/branoholy/neatoc/tree/master/examples) for +```bash +$ make install +$ ldconfig +``` + +To uninstall: + +```bash +$ make uninstall +``` + +## Examples +See [examples](https://github.com/branoholy/neatoc/tree/master/examples) for more information about using of this library. -`neatoc-scan` is a simple example that connects to the Neato and performs one +`neatoc-scan` is a simple example that connects to the Neato and performs one scan that is printed. `neatoc-scan-gui` is more complex and requires wxWidgets library. It can be used to drive with the Neato, scan automatically or manually, and log the output. -License -------- -NeatoC is licensed under GNU GPL v3 (see -[LICENSE](https://github.com/branoholy/neatoc/blob/master/LICENSE) +## License +NeatoC is licensed under GNU GPL v3 (see +[LICENSE](https://github.com/branoholy/neatoc/blob/master/LICENSE) file).