Skip to content

Commit

Permalink
Tune tutorial introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
orzechow committed Nov 15, 2024
1 parent 4349caf commit 7a90d13
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions docs/Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Let's write an agent for the famous PacMan game using Arbitration Graphs 🕹️

**TL;DR**: Find links to the individual tasks at the bottom of this page.
**TL;DR:** Find links to the individual tasks at the bottom of this page.

## Introduction

Expand All @@ -22,7 +22,16 @@ The tutorial is structured into several tasks that are meant to be completed in

### What to find where

Let's take a look at the structure and content of the `arbitration_graphs/demo` directory.
Let's take a look at the structure and content of the `arbitration_graphs/demo/` directory.

```
demo
├── include
├── src
├── test
└── …
```

All header files can be found in the `include/demo/` directory with corresponding implementation files in the `src/` directory.
The entire demo is thoroughly tested using the unit tests you'll find in the `test/` directory.

Expand Down Expand Up @@ -50,10 +59,10 @@ The easiest way to get started is to use the provided docker setup.
Start by checking out the `tutorial` branch where we have removed some parts
of the demo implementation for the purpose of this tutorial.
```bash
git checkout tutorial
git clone --branch tutorial https://github.com/KIT-MRT/arbitration_graphs.git
```

To be dropped into an interactive shell with all required dependencies installed
To start an interactive shell in the docker container with all required dependencies installed
and the current directory mounted, run
```bash
cd arbitration_graphs/demo
Expand Down

0 comments on commit 7a90d13

Please sign in to comment.