diff --git a/README.md b/README.md index 2c3ce1f517c0f2539e4cbf9550327e8cb48a3c2d..481a532c0d1f82d11245eb331886152d07416b34 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,31 @@ # Description - +This package provide some user launch files and config files to start up the model car and run some advanced functionalities. Check the main [model car documentation](https://gitlab.iri.upc.edu/mobile_robotics/adc/platforms/model_car/iri_model_car_how_to) for further information. # Dependencies +This node has the following dependencies: +* none # Install -However, this package is normally used as part of a wider installation (i.e. a -robot, an experiment or a demosntration) which will normally include a complete -rosinstall file to be used with the [wstool](http://wiki.ros.org/wstool) tool. +Move to the active workspace: +```bash +roscd && cd ../src +``` +Clone the repository: +```bash +git clone <url> +``` +Install ROS dependencies: +``` +roscd +cd .. +rosdep install -i -r --from-paths src +``` +Compile the workspace: +``` +catkin_make +``` # How to use it +This package provide differents launch files that can be tested.