Updates readme.

Signed-off-by: Franco Cipollone <[email protected]>
francocipollone · Mar 15, 2023 · a71fb34 · a71fb34
1 parent 918b72c
commit a71fb34
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 48 deletions.
diff --git a/controllers/maliput_rail_car/maliput_rail_car.py b/controllers/maliput_rail_car/maliput_rail_car.py
diff --git a/readme.md b/readme.md
@@ -1,10 +1,32 @@
+# Maliput-Webots Worlds
+
+
+## Description
+
+This repository contains a Webots project with:
+ - Wolds:
+   - Two simple road networks are provided
+ - Controller:
+   - Pure pursuit controller that uses [maliput](https://maliput.readthedocs.io/en/latest/) for representing the road network.
+
+
+## Requirements
+
+- maliput (Foxy):
+  - [Maliput Binary installation](https://maliput.readthedocs.io/en/latest/installation.html#id6)
+    - It is recommended to install the `maliput-full` package.
+- Webots
+  - [Webots installation](https://cyberbotics.com/doc/guide/installing-webots)
+
+## Try it!
+
 source underlying binaries
 
 ```
 source /opt/ros/foxy/setup.bash
 ```
 
-Run webots and user the user interface to load your desired world.
+Run webots and use the user interface to load your desired world.
 
 ```
 webots
@@ -16,7 +38,7 @@ or directly run webots using the desired world.
 webots worlds/loop_road_pedestrian_crosswalk_single_agent.wbt
 ```
 
-Available worlds:
+## Available worlds
  - loop_road_pedestrian_crosswalk_single_agent.wbt
  - loop_road_pedestrian_crosswalk_multi_agent.wbt
  - circuit_single_agent.wbt