Skip to content

Commit

Permalink
add versioning section in README
Browse files Browse the repository at this point in the history
  • Loading branch information
Julian Arkenau committed Oct 9, 2023
1 parent b400a82 commit bb354c2
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,16 @@ This repository is based on public template from Allison Thackston for a [generi
- The Docker image is quite larage (around 7.5GB), keep that in mind when deleting, downloading or rebuilding the image.
- **The Container has evelated privileges for performing networking administration**. This gives the container control over the hosts network stack.

## Versioning

The Docker image with the `latest` tag is rebuilt weekly, to frequently incoperate updates. This may cause instabilities. For a stable version, choose an image based on a release and update it in `devcontainer.json`:

```json
{
"image": "ghcr.io/dfki-ni/turtlebot4_dev_container:[tag]",
}
```

## TODOs

- [ ] Provide setup scripts for the discovery server setup.
Expand Down

0 comments on commit bb354c2

Please sign in to comment.