Skip to content

Commit

Permalink
add doc section for docker container support.
Browse files Browse the repository at this point in the history
Signed-off-by: Tomoya.Fujita <[email protected]>
  • Loading branch information
fujitatomoya committed Dec 28, 2023
1 parent 3b5a727 commit 7b64054
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,25 @@ https://github.com/fujitatomoya/ros2ai/assets/43395114/78a0799b-40e3-4dc8-99cb-4
| Distribution | Supported | Note |
| :---------------- | :-------- | :--- |
| Rolling Ridley || Development / Mainstream Branch |
| Iron Irwini | | W.I.P (No distro specific dependency, should work.) |
| Humble Hawksbill | | W.I.P (No distro specific dependency, should work.) |
| Iron Irwini | | |
| Humble Hawksbill | | |

> [!NOTE]
> Verified on [Ubuntu 22.04 Jammy Jellyfish](https://releases.ubuntu.com/jammy/) only, other platform would also work.
## Installation

### Docker Container

see available images for [tomoyafujita/ros2ai@dockerhub](https://hub.docker.com/repository/docker/tomoyafujita/ros2ai/tags?page=1&ordering=last_updated)

```bash
docker run -it --rm -e OPENAI_API_KEY=$OPENAI_API_KEY tomoyafujita/ros2ai:humble
```

> [!NOTE]
> `OPENAI_API_KEY` environmental variable must be set
### Required Package

```bash
Expand Down

0 comments on commit 7b64054

Please sign in to comment.