From e633cf9d89775aca25dca43c8c50514f3ed1332a Mon Sep 17 00:00:00 2001 From: Christian Geller Date: Mon, 29 Jan 2024 14:52:57 +0100 Subject: [PATCH] Update readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b7093a1..80f05aae 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,15 @@ > [!IMPORTANT] > This repository is a minimal fork of the official [ros-bridge](https://github.com/carla-simulator/ros-bridge)! All modifications to the original repository are documented in [FEATURES.md](./FEATURES.md). -> [!RECOMMENDATION] -> We recommend to use the *carla-ros-bridge* as **communication actor** in our open, modular and scalable simulation framework **CARLOS**. Here, it is the component that facilitates the powerful combination of CARLA and ROS. The component retrieves data from the simulation to publish it over ROS topics while simultaneously listening on different topics for requested actions, which are translated to commands to be executed in CARLA. It does this by using both the ROS communication standard DDS, as well as RPC via the CARLA Python API, in tandem, effectively bridging the two. Here, [docker-ros](https://github.com/ika-rwth-aachen/docker-ros) enables a continual building of container images with recent versions of ROS, Python, and Ubuntu. +> [!TIP] +> We recommend to use the *carla-ros-bridge* as **communication actor** in our open, modular and scalable simulation framework **CARLOS**. +> Here, it is the component that facilitates the powerful combination of CARLA and ROS. The component retrieves data from the simulation to publish it over ROS topics while simultaneously listening on different topics for requested actions, which are translated to commands to be executed in CARLA. It does this by using both the ROS communication standard DDS, as well as RPC via the CARLA Python API, in tandem, effectively bridging the two. Here, [docker-ros](https://github.com/ika-rwth-aachen/docker-ros) enables a continual building of container images with recent versions of ROS, Python, and Ubuntu. -**Note**: Please also have look to the [ROS specific README](./docker/README.md) giving detailed insights about available ROS nodes, topics and services but also useful information about the containerization. +> [!TIP] +> Please also have look to the [ROS specific README](./docker/README.md) giving detailed insights about available ROS nodes, topics and services but also useful information about the containerization. -**Note**: We set up a Continous Integration (CI) pipeline as [GitHub action](./github/workflows/docker.yml) to continously build Docker images for the `carla-ros-bridge`, publicly available on [Docker Hub](https://hub.docker.com/r/rwthika/carla-ros-bridge). +> [!NOTE] +> We set up a Continous Integration (CI) pipeline as [GitHub action](./github/workflows/docker.yml) to continously build Docker images for the `carla-ros-bridge`, publicly available on [Docker Hub](https://hub.docker.com/r/rwthika/carla-ros-bridge). --- ---