From de67f41c83b5f6a633ffd18a121e0fda7cdab566 Mon Sep 17 00:00:00 2001 From: Piotr Spieker Date: Fri, 15 Nov 2024 17:05:32 +0100 Subject: [PATCH] Add a short Readme for the Demo (in case it's opened as top-level dir in an IDE) --- demo/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 demo/README.md diff --git a/demo/README.md b/demo/README.md new file mode 100644 index 00000000..834175e3 --- /dev/null +++ b/demo/README.md @@ -0,0 +1,20 @@ +# Arbitration Graphs Demo and Tutorial + +This is a demo of the [arbitration_graphs](https://github.com/KIT-MRT/arbitration_graphs) library using Pac-Man as an example application. +The arbitration graph controls Pac-Man on its journey to collect tasty dots 🍬 + +Run the demo with: + +```bash +git clone https://github.com/KIT-MRT/arbitration_graphs.git +cd arbitration_graphs/demo +docker compose up +``` + +Open the GUI with your favorite browser: +[http://0.0.0.0:8080](http://0.0.0.0:8080) + + +## Tutorial + +If you're here for the tutorial, follow the instructions on our [Tutorial GitHub Page](https://kit-mrt.github.io/arbitration_graphs/docs/Tutorial.md). \ No newline at end of file