From d45047bea1f2120fbcb0ecbc2fd0d185fae3ba36 Mon Sep 17 00:00:00 2001 From: Sergi Hernandez Juan <shernand@iri.upc.edu> Date: Fri, 5 Feb 2021 17:09:47 +0100 Subject: [PATCH] Updated the README file. --- ReadMe.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/ReadMe.md b/ReadMe.md index 417b734..44231ca 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -5,9 +5,12 @@ autonomous_driving_tools {#mainpage} 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). +* **[gradient](doc/gradient.md)**: simple implementatio of the gradient descent algorithm. +* **[g2_spline](doc/g2_spline.md)**: implementation of the G2 splines (quintic splines). +* **[dijkstra](doc/dijkstra.md)**: simple implementation of the Dijkstra algorithm. +* **[opendrive_road](doc/opendrive.md)** : Parser for the Opendrive format. + +Follow the previous links for a more detailes description of each tool. ## Dependencies @@ -15,11 +18,16 @@ 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 +* [boost]() +* [Eigen3](http://eigen.tuxfamily.org/index.php?title=Main_Page "Eigen's Homepage"), a matrix handling library +* [xsd-cxx](https://www.codesynthesis.com/projects/xsd/) and libxerces-c, an XML parser library Under linux all of these utilities are available in ready-to-use packages. +``` +sudo apt-get install cmake doxygen eigen sxd-cxx libxerces-c +``` + Under MacOS most of the packages are available via [fink](http://www.finkproject.org/ "Fink's Homepage") ## Compilation and installation -- GitLab