diff --git a/README.md b/README.md index 178aa0109a..4684c39e11 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,20 @@ # Foxglove Studio for Arena Web-Application -More information on Foxglove Studio: https://github.com/foxglove/studio +![Arena Rosnav version](https://img.shields.io/github/v/tag/Arena-Rosnav/arena-rosnav?label=Arena%20Rosnav%20version) + +## Introduction +This repository represents Foxglove visualization support for ROS (Robotic Operating System) based [full-stack application](https://github.com/Arena-Rosnav/arena-web-v2). Foxglove has been integrated within to enable advanced data and objects visualization of robot activities generated and distributed by [Arena Rosnav project](https://github.com/Arena-Rosnav/Arena-Rosnav). +Contribution from this integration comprises implemention of special extensions meant to covert _ROS topics_ into the format understandable by the Foxglove. In this manner we developed support for pedestrains movements, navigation stack parameters and occupancy map. ## Installation +- Make sure to adequately setup the Arena-Web application from this [guide](https://github.com/Arena-Rosnav/arena-web-v2/blob/master/README.md): + +- Navigate into `packages` directory: +``` +cd ~/arena-web-v2/packages +``` + - Clone this repository ``` @@ -40,3 +51,5 @@ npm run web:build:prod ``` npm run web:serve ``` + +For more information on Foxglove Studio, plase visit the official repository: https://github.com/foxglove/studio