diff --git a/ReadMe.md b/ReadMe.md index ca4aa961227a25df5ff1e1f4168633ed55b06983..c369be5a857812570138e2c9c6128ff53d452b46 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -3,7 +3,11 @@ iri_autonomous_driving_tools {#mainpage} ## Description -set of tools useful for autonomous driving +Set of useful tools for autonomous driving of car-like robots. At the moment the tools included in this library are: + +* **gradient**: simple implementatio of the [gradient descent algorithm](https://en.wikipedia.org/wiki/Gradient_descent). +* **g2_spline**: implementation of the G2 splines (quintic splines). +* **dijkstra**: simple implementation of the [Dijkstra algorithm](https://en.wikipedia.org/wiki/Dijkstra%27s_algorithm). ## Dependencies @@ -12,13 +16,12 @@ This package requires of the following system libraries and packages * [cmake](https://www.cmake.org "CMake's Homepage"), a cross-platform build system. * [doxygen](http://www.doxygen.org "Doxygen's Homepage") and [graphviz](http://www.graphviz.org "Graphviz's Homepage") to generate the documentation. * stdc++ and pthread libraries. +* [Eigen](http://eigen.tuxfamily.org/index.php?title=Main_Page "Eigen's Homepage"), a matrix handling library Under linux all of these utilities are available in ready-to-use packages. Under MacOS most of the packages are available via [fink](http://www.finkproject.org/ "Fink's Homepage") -This package also requires of the following IRI libraries: - ## Compilation and installation Download this repository and create a build folder inside: