Skip to content

Commit

Permalink
docs(README): add some description about requirements and how to run …
Browse files Browse the repository at this point in the history
…the container
  • Loading branch information
rodrigocaus committed Nov 9, 2020
1 parent b45e7ab commit e944c31
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,35 @@

Docker files to generate and run a container with GER VSSS team strategy

## Requirements

- Docker 19.03+

## Build image

Run the shell script:
```bash
$ ./dockerbuild.sh
```
Use `chmod +x` or `chmod 777` to give shell script some permissions.

## Run the container

Run the shell script:
```bash
$ ./rundocker.sh
```

If you want to select the team color or other network config,
change the variables on top of *rundocker.sh*. Default is:
```bash
TEAM_YELLOW=false

MULTICAST_IP=224.0.0.1
COMMAND_IP=127.0.0.1

COMMAND_PORT=20011
VISION_PORT=10002
REFEREE_PORT=10003
REPLACER_PORT=10004
```

0 comments on commit e944c31

Please sign in to comment.